HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.
Expand or mouse-over a field for more information about it.
apiVersion:kind:metadata:
annotations:
[string]:clusterName:creationTimestamp:deletionGracePeriodSeconds:deletionTimestamp:finalizers:
- [string]:generateName:generation:initializers:
pending:
- name:result:
apiVersion:code:details:
causes:
- field:message:reason:group:kind:name:retryAfterSeconds:uid:kind:message:metadata:
continue:resourceVersion:selfLink:reason:status:labels:
[string]:name:namespace:ownerReferences:
- apiVersion:blockOwnerDeletion:controller:kind:name:uid:resourceVersion:selfLink:uid:spec:
maxReplicas:metrics:
- object:
- metricName:target:
apiVersion:kind:name:targetValue:pods:
metricName:targetAverageValue:resource:
name:targetAverageUtilization:targetAverageValue:type:minReplicas:scaleTargetRef:
apiVersion:kind:name:status:
conditions:
- lastTransitionTime:message:reason:status:type:currentMetrics:
- object:
- currentValue:metricName:target:
apiVersion:kind:name:pods:
currentAverageValue:metricName:resource:
currentAverageUtilization:currentAverageValue:name:type:currentReplicas:desiredReplicas:lastScaleTime:observedGeneration:
Create a HorizontalPodAutoscaler
POST /apis/autoscaling/v2beta1/horizontalpodautoscalers HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
$ curl -k \
-X POST \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/horizontalpodautoscalers <<'EOF'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
EOF
Create a HorizontalPodAutoscaler
POST /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
$ curl -k \
-X POST \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers <<'EOF'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
EOF
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
Read the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |
List or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/horizontalpodautoscalers HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/horizontalpodautoscalers
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
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 indicating the client must restart their list without the continue field. 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 |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
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 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 |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
List or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
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 indicating the client must restart their list without the continue field. 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 |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
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 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 |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch changes to an object of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/watch/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/watch/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
continue |
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 indicating the client must restart their list without the continue field. 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 |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
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 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 |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch individual changes to a list of HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/watch/horizontalpodautoscalers
| Parameter | Description |
|---|---|
continue |
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 indicating the client must restart their list without the continue field. 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 |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
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 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 |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Watch individual changes to a list of HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/watch/namespaces/$NAMESPACE/horizontalpodautoscalers HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/watch/namespaces/$NAMESPACE/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
continue |
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 indicating the client must restart their list without the continue field. 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 |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
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 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 |
If 'true', then the output is pretty printed. |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Replace the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
$ curl -k \
-X PUT \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME <<'EOF'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
EOF
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |
Partially update the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME <<'EOF'
{
...
}
EOF
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |
Delete a HorizontalPodAutoscaler
DELETE /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
...
}
$ curl -k \
-X DELETE \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME <<'EOF'
{
...
}
EOF
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
gracePeriodSeconds |
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 |
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 |
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. |
Delete collection of HorizontalPodAutoscaler
DELETE /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-X DELETE \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace |
object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty |
If 'true', then the output is pretty printed. |
continue |
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 indicating the client must restart their list without the continue field. 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 |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
includeUninitialized |
If true, partially initialized resources are included in the response. |
labelSelector |
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 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 |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
timeoutSeconds |
Timeout for the list/watch call. |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
Read status of the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME/status HTTP/1.1 Authorization: Bearer $TOKEN Accept: application/json Connection: close
$ curl -k \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME/status
Replace status of the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
$ curl -k \
-X PUT \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME/status <<'EOF'
{
"kind": "HorizontalPodAutoscaler",
"apiVersion": "autoscaling/v2beta1",
...
}
EOF
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |
Partially update status of the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME/status HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'
{
...
}
$ curl -k \
-X PATCH \
-d @- \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json-patch+json' \
https://$ENDPOINT/apis/autoscaling/v2beta1/namespaces/$NAMESPACE/horizontalpodautoscalers/$NAME/status <<'EOF'
{
...
}
EOF
| Parameter | Description |
|---|---|
name |
name of the HorizontalPodAutoscaler |
namespace |
object name and auth scope, such as for teams and projects |