Get cluster namespace HAPs list

Get the list of HPA in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/hpas

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastTransitionTimestring

Example: "2023-06-28 05:47:42"

messagestring

Example: "recent recommendations were higher than current one, applying the highest recent recommendation"

reasonstring

Example: "ScaleDownStabilized"

statusstring

status(True or False)

Example: "True"

typestring

Example: "AbleToScale"

creationTimestampstring

Example: "2023-06-14 09:39:07"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"autoscaling/v2\",\"kind\":\"HorizontalPodAutoscaler\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: autoscaling/v2\nkind: HorizontalPodAutoscaler\nmetadata..."

detailDetail (object)

creationTimestring

Example: "2023-06-14 09:38:52"

currentReplicasinteger

Current replicas count

Example: 1

desiredReplicasinteger

Number of replicas to provide

Example: 1

labelsobject

additionalPropstring

lastScaleTimestring

Example: "2023-07-03 06:53:41"

maxReplicasinteger

Maximum replicas count

Example: 3

metricsarray of object

Target metric

additionalPropstring

minReplicasinteger

Minimum replicas count

Example: 2

namestring

Example: "api-server-hpa"

namespacestring

namespace name

Example: "cocktail-system"

targetstring

Example: "Deployment: cocktail-api-server"

maxReplicasinteger

Maximum replicas count

Example: 3

metricsarray of Metrics (object)

Target metric

currentAverageUtilizationinteger

Current value of the average pod resource metric (expressed as a percentage of requested resource values for pods)

Example: 0

currentAverageValuestring

Current value of the average pod metric

Example: "5m"

currentValueinteger

Current value of the metric (quantity)

metricTypestring

metricType(Object, Pods, Resource, External)

Example: "Resource"

namestring

Example: "cpu"

targetAverageUtilizationinteger

Average target value of pod resource metrics (expressed as a percentage of requested resource values for pods)

Example: 70

targetTypestring

Utilization or Value or AverageValue

Example: "Utilization"

minReplicasinteger

Minimum replicas count

Example: 2

namestring

HPA name

Example: "api-server-hpa"

namespacestring

namespace name

Example: "cocktail-system"

scaleTargetRefScaleTargetRef (object)

apiVersionstring

Example: "apps/v1"

kindstring

Example: "Deployment"

namestring

Example: "cocktail-api-server"

startTimestring

Example: "2023-06-28 05:47:26"

Request

const response = await fetch('/v1/clusters/{clusterId}/namespaces/{namespaceName}/hpas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "conditions": [
      {
        "lastTransitionTime": "2023-06-28 05:47:42",
        "message": "recent recommendations were higher than current one, applying the highest recent recommendation",
        "reason": "ScaleDownStabilized",
        "status": "True",
        "type": "AbleToScale"
      }
    ],
    "creationTimestamp": "2023-06-14 09:39:07",
    "deployment": "{\"apiVersion\":\"autoscaling/v2\",\"kind\":\"HorizontalPodAutoscaler\"...",
    "deploymentYaml": "apiVersion: autoscaling/v2\nkind: HorizontalPodAutoscaler\nmetadata...",
    "detail": {
      "creationTime": "2023-06-14 09:38:52",
      "currentReplicas": 1,
      "desiredReplicas": 1,
      "labels": {
        "app": "api-server-hpa"
      },
      "lastScaleTime": "2023-07-03 06:53:41",
      "maxReplicas": 3,
      "metrics": [
        {
          "currentAverageUtilization": 0,
          "currentAverageValue": "5m",
          "currentValue": "0",
          "metricType": "Resource",
          "name": "cpu",
          "targetAverageUtilization": 70,
          "targetType": "Utilization"
        }
      ],
      "minReplicas": 2,
      "name": "api-server-hpa",
      "namespace": "cocktail-system",
      "target": "Deployment: cocktail-api-server"
    },
    "maxReplicas": 3,
    "metrics": [
      {
        "currentAverageUtilization": 0,
        "currentAverageValue": "5m",
        "metricType": "Resource",
        "name": "cpu",
        "targetAverageUtilization": 70,
        "targetType": "Utilization"
      }
    ],
    "minReplicas": 2,
    "name": "api-server-hpa",
    "namespace": "cocktail-system",
    "scaleTargetRef": {
      "apiVersion": "apps/v1",
      "kind": "Deployment",
      "name": "cocktail-api-server"
    },
    "startTime": "2023-06-28 05:47:26"
  }
]