Scale [autoscaling/v1] - Autoscale APIs | API reference

Specification
- .spec
- .status
API endpoints

Description: Scale represents a scaling request for a resource.
Type: object

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
`spec`	`object`	ScaleSpec describes the attributes of a scale subresource.
`status`	`object`	ScaleStatus represents the current status of a scale subresource.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.

spec

object

ScaleSpec describes the attributes of a scale subresource.

status

object

ScaleStatus represents the current status of a scale subresource.

.spec

Description: ScaleSpec describes the attributes of a scale subresource.
Type: object

Property Type Description

Property	Type	Description
`replicas`	`integer`	desired number of instances for the scaled object.

replicas

integer

desired number of instances for the scaled object.

.status

Description

ScaleStatus represents the current status of a scale subresource.

Type

object

Required

replicas

Property Type Description

Property	Type	Description
`replicas`	`integer`	actual number of observed instances of the scaled object.
`selector`	`string`	label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

replicas

integer

actual number of observed instances of the scaled object.

selector

string

label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

API endpoints

The following API endpoints are available:

/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
- GET: read scale of the specified deployment
- PATCH: partially update scale of the specified deployment
- PUT: replace scale of the specified deployment
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
- GET: read scale of the specified ReplicaSet
- PATCH: partially update scale of the specified ReplicaSet
- PUT: replace scale of the specified ReplicaSet
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
- GET: read scale of the specified StatefulSet
- PATCH: partially update scale of the specified StatefulSet
- PUT: replace scale of the specified StatefulSet
/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
- GET: read scale of the specified ReplicationController
- PATCH: partially update scale of the specified ReplicationController
- PUT: replace scale of the specified ReplicationController

/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale

Table 1. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Scale
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 2. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read scale of the specified deployment

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update scale of the specified deployment

Table 4. Query parameters
Parameter	Type	Description
`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 5. Body parameters
Parameter	Type	Description
`body`	`Patch` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace scale of the specified deployment

Table 7. Query parameters
Parameter	Type	Description
`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 8. Body parameters
Parameter	Type	Description
`body`	`Scale` schema

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale

Table 10. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Scale
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 11. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read scale of the specified ReplicaSet

Table 12. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update scale of the specified ReplicaSet

Table 13. Query parameters
Parameter	Type	Description
`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 14. Body parameters
Parameter	Type	Description
`body`	`Patch` schema

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace scale of the specified ReplicaSet

Table 16. Query parameters
Parameter	Type	Description
`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 17. Body parameters
Parameter	Type	Description
`body`	`Scale` schema

Table 18. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale

Table 19. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Scale
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 20. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read scale of the specified StatefulSet

Table 21. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update scale of the specified StatefulSet

Table 22. Query parameters
Parameter	Type	Description
`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 23. Body parameters
Parameter	Type	Description
`body`	`Patch` schema

Table 24. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace scale of the specified StatefulSet

Table 25. Query parameters
Parameter	Type	Description
`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 26. Body parameters
Parameter	Type	Description
`body`	`Scale` schema

Table 27. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale

Table 28. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the Scale
`namespace`	`string`	object name and auth scope, such as for teams and projects

Table 29. Global query parameters
Parameter	Type	Description
`pretty`	`string`	If 'true', then the output is pretty printed.

HTTP method: GET
Description: read scale of the specified ReplicationController

Table 30. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update scale of the specified ReplicationController

Table 31. Query parameters
Parameter	Type	Description
`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 32. Body parameters
Parameter	Type	Description
`body`	`Patch` schema

Table 33. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace scale of the specified ReplicationController

Table 34. Query parameters
Parameter	Type	Description
`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 35. Body parameters
Parameter	Type	Description
`body`	`Scale` schema

Table 36. HTTP responses
HTTP code	Reponse body
200 - OK	`Scale` schema
201 - Created	`Scale` schema
401 - Unauthorized	Empty