Kubernetes Reference
HorizontalPodAutoscaler

HorizontalPodAutoscaler

HorizontalPodAutoscaler

apiVersion: autoscaling/v1
import "k8s.io/api/autoscaling/v1"

HorizontalPodAutoscaler

configuration of a horizontal pod autoscaler.

HorizontalPodAutoscalerSpec

specification of a horizontal pod autoscaler.

  • maxReplicas (int32), required
    upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
  • scaleTargetRef (CrossVersionObjectReference), required
    reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.
    CrossVersionObjectReference contains enough information to let you identify the referred resource.
  • minReplicas (int32)
    minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
  • targetCPUUtilizationPercentage (int32)
    target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.

HorizontalPodAutoscalerStatus

current status of a horizontal pod autoscaler

  • currentReplicas (int32), required
    current number of replicas of pods managed by this autoscaler.
  • desiredReplicas (int32), required
    desired number of replicas of pods managed by this autoscaler.
  • currentCPUUtilizationPercentage (int32)
    current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70%!o(MISSING)f its requested CPU.
  • lastScaleTime (Time)
    last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
  • observedGeneration (int64)
    most recent generation observed by this autoscaler.

HorizontalPodAutoscalerList

list of horizontal pod autoscaler objects.

  • apiVersion: autoscaling/v1

  • kind: HorizontalPodAutoscalerList

  • metadata (ListMeta)
    Standard list metadata.

  • items ([]HorizontalPodAutoscaler), required
    list of horizontal pod autoscaler objects.

Operations

get read the specified HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters
  • {name} (string), required
    name of the HorizontalPodAutoscaler
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (HorizontalPodAutoscaler): OK
401: Unauthorized

get read status of the specified HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Parameters
  • {name} (string), required
    name of the HorizontalPodAutoscaler
  • {namespace} (string), required
    namespace
  • ?pretty (string)
    pretty
Response

200 (HorizontalPodAutoscaler): OK
401: Unauthorized

list list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Parameters
Response

200 (HorizontalPodAutoscalerList): OK
401: Unauthorized

list list or watch objects of kind HorizontalPodAutoscaler

HTTP Request

GET /apis/autoscaling/v1/horizontalpodautoscalers

Parameters
Response

200 (HorizontalPodAutoscalerList): OK
401: Unauthorized

create create a HorizontalPodAutoscaler

HTTP Request

POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Parameters
Response

200 (HorizontalPodAutoscaler): OK
201 (HorizontalPodAutoscaler): Created
202 (HorizontalPodAutoscaler): Accepted
401: Unauthorized

update replace the specified HorizontalPodAutoscaler

HTTP Request

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters
Response

200 (HorizontalPodAutoscaler): OK
201 (HorizontalPodAutoscaler): Created
401: Unauthorized

update replace status of the specified HorizontalPodAutoscaler

HTTP Request

PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Parameters
Response

200 (HorizontalPodAutoscaler): OK
201 (HorizontalPodAutoscaler): Created
401: Unauthorized

patch partially update the specified HorizontalPodAutoscaler

HTTP Request

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters

  • {name} (string), required
    name of the HorizontalPodAutoscaler

  • {namespace} (string), required
    namespace

  • body (Patch), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?force (boolean)
    force

  • ?pretty (string)
    pretty

Response

200 (HorizontalPodAutoscaler): OK
401: Unauthorized

patch partially update status of the specified HorizontalPodAutoscaler

HTTP Request

PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status

Parameters

  • {name} (string), required
    name of the HorizontalPodAutoscaler

  • {namespace} (string), required
    namespace

  • body (Patch), required

  • ?dryRun (string)
    dryRun

  • ?fieldManager (string)
    fieldManager

  • ?force (boolean)
    force

  • ?pretty (string)
    pretty

Response

200 (HorizontalPodAutoscaler): OK
401: Unauthorized

delete delete a HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}

Parameters
Response

200 (Status): OK
202 (Status): Accepted
401: Unauthorized

deletecollection delete collection of HorizontalPodAutoscaler

HTTP Request

DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

Parameters
Response

200 (Status): OK
401: Unauthorized

What's on this Page