HorizontalPodAutoscaler [autoscaling/v1]

    configuration of a horizontal pod autoscaler.

    Type

    .spec

    Description

    specification of a horizontal pod autoscaler.

    Type

    object

    Required

    • scaleTargetRef

    • maxReplicas

    PropertyTypeDescription

    maxReplicas

    integer

    upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.

    minReplicas

    integer

    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.

    scaleTargetRef

    object

    CrossVersionObjectReference contains enough information to let you identify the referred resource.

    targetCPUUtilizationPercentage

    integer

    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.

    .spec.scaleTargetRef

    Description

    CrossVersionObjectReference contains enough information to let you identify the referred resource.

    Type

    object

    Required

    • name

    PropertyTypeDescription

    apiVersion

    string

    API version of the referent

    kind

    string

    Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"

    name

    string

    Name of the referent; More info:

    .status

    Description

    current status of a horizontal pod autoscaler

    Type

    object

    Required

    • currentReplicas

    • desiredReplicas

    PropertyTypeDescription

    currentCPUUtilizationPercentage

    integer

    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% of its requested CPU.

    currentReplicas

    integer

    current number of replicas of pods managed by this autoscaler.

    desiredReplicas

    integer

    desired number of replicas of pods managed by this autoscaler.

    lastScaleTime

    Time meta/v1

    last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.

    observedGeneration

    integer

    most recent generation observed by this autoscaler.

    API endpoints

    The following API endpoints are available:

    • /apis/autoscaling/v1/horizontalpodautoscalers

      • GET: list or watch objects of kind HorizontalPodAutoscaler
    • /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers

      • DELETE: delete collection of HorizontalPodAutoscaler

      • GET: list or watch objects of kind HorizontalPodAutoscaler

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

      • DELETE: delete a HorizontalPodAutoscaler

      • GET: read the specified HorizontalPodAutoscaler

      • PATCH: partially update the specified HorizontalPodAutoscaler

      • PUT: replace the specified HorizontalPodAutoscaler

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

      • GET: read status of the specified HorizontalPodAutoscaler

      • PATCH: partially update status of the specified HorizontalPodAutoscaler

    Table 1. Global query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    pretty

    string

    If ‘true’, then the output is pretty printed.

    resourceVersion

    string

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    HTTP method

    GET

    Description

    list or watch objects of kind HorizontalPodAutoscaler

    Table 2. HTTP responses
    HTTP codeReponse body

    200 - OK

    Table 3. Global path parameters
    ParameterTypeDescription

    namespace

    string

    object name and auth scope, such as for teams and projects

    Table 4. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete collection of HorizontalPodAutoscaler

    Table 5. Query parameters
    ParameterTypeDescription

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    Table 6. Body parameters
    ParameterTypeDescription

    body

    DeleteOptions meta/v1

    Table 7. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    GET

    Description

    list or watch objects of kind HorizontalPodAutoscaler

    Table 8. Query parameters
    ParameterTypeDescription

    allowWatchBookmarks

    boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

    continue

    string

    The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the “next key”.

    This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

    fieldSelector

    string

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    labelSelector

    string

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    limit

    integer

    limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

    The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

    resourceVersion

    string

    resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

    Defaults to unset

    resourceVersionMatch

    string

    resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See for details.

    Defaults to unset

    timeoutSeconds

    integer

    Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

    watch

    boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    HTTP method

    POST

    Description

    create a HorizontalPodAutoscaler

    Table 10. Query parameters
    ParameterTypeDescription

    dryRun

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    Table 11. Body parameters
    ParameterTypeDescription

    Table 12. HTTP responses
    HTTP codeReponse body

    200 - OK

    HorizontalPodAutoscaler autoscaling/v1

    Table 13. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the HorizontalPodAutoscaler

    namespace

    string

    object name and auth scope, such as for teams and projects

    Table 14. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    DELETE

    Description

    delete a HorizontalPodAutoscaler

    Table 15. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    gracePeriodSeconds

    integer

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    orphanDependents

    boolean

    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the “orphan” finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both.

    propagationPolicy

    string

    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: ‘Orphan’ - orphan the dependents; ‘Background’ - allow the garbage collector to delete the dependents in the background; ‘Foreground’ - a cascading policy that deletes all dependents in the foreground.

    Table 16. Body parameters
    ParameterTypeDescription

    body

    Table 17. HTTP responses
    HTTP codeReponse body

    200 - OK

    Status meta/v1

    HTTP method

    GET

    Description

    read the specified HorizontalPodAutoscaler

    Table 18. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    PATCH

    Description

    partially update the specified HorizontalPodAutoscaler

    Table 19. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 20. Body parameters
    ParameterTypeDescription

    body

    HTTP method

    PUT

    Description

    replace the specified HorizontalPodAutoscaler

    Table 22. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

    Table 23. Body parameters
    ParameterTypeDescription

    body

    Table 24. HTTP responses
    HTTP codeReponse body

    200 - OK

    HorizontalPodAutoscaler autoscaling/v1

    Table 25. Global path parameters
    ParameterTypeDescription

    name

    string

    name of the HorizontalPodAutoscaler

    namespace

    string

    object name and auth scope, such as for teams and projects

    Table 26. Global query parameters
    ParameterTypeDescription

    pretty

    string

    If ‘true’, then the output is pretty printed.

    HTTP method

    GET

    Description

    read status of the specified HorizontalPodAutoscaler

    Table 27. HTTP responses
    HTTP codeReponse body

    200 - OK

    HTTP method

    PATCH

    Description

    partially update status of the specified HorizontalPodAutoscaler

    Table 28. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).

    force

    boolean

    Force is going to “force” Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.

    Table 29. Body parameters
    ParameterTypeDescription

    body

    Table 30. HTTP responses
    HTTP codeReponse body

    200 - OK

    HorizontalPodAutoscaler autoscaling/v1

    HTTP method

    PUT

    Description

    replace status of the specified HorizontalPodAutoscaler

    Table 31. Query parameters
    ParameterTypeDescription

    dryRun

    string

    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

    fieldManager

    string

    fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by .

    Table 32. Body parameters
    ParameterTypeDescription

    body