Phillip Wittrock
5.2 KiB
Scale v1
| Group | Version | Kind |
|---|---|---|
| Core | v1 | Scale |
Scale represents a scaling request for a resource.
| Field | 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: http://releases.k8s.io/HEAD/docs/devel/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: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
| metadata ObjectMeta |
Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata. |
| spec ScaleSpec |
defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. |
| status ScaleStatus |
current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only. |
ScaleSpec v1
| Field | Description |
|---|---|
| replicas integer |
desired number of instances for the scaled object. |
ScaleStatus v1
| Field | 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 |
Misc Operations
See supported operations below...
Read Scale
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
read scale of the specified Scale
HTTP Request
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the Scale |
| namespace | object name and auth scope, such as for teams and projects |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
Response
| Code | Description |
|---|---|
| 200 Scale |
OK |
Replace Scale
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
replace scale of the specified Scale
HTTP Request
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the Scale |
| namespace | object name and auth scope, such as for teams and projects |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
Body Parameters
| Parameter | Description |
|---|---|
| body Scale |
Response
| Code | Description |
|---|---|
| 200 Scale |
OK |
Patch Scale
bdocs-tab:kubectl
kubectlCommand
Coming Soon
bdocs-tab:curl
curlCommand (requireskubectl proxyto be running)
Coming Soon
bdocs-tab:kubectl Output
Coming Soon
bdocs-tab:curl Response Body
Coming Soon
partially update scale of the specified Scale
HTTP Request
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Path Parameters
| Parameter | Description |
|---|---|
| name | name of the Scale |
| namespace | object name and auth scope, such as for teams and projects |
Query Parameters
| Parameter | Description |
|---|---|
| pretty | If 'true', then the output is pretty printed. |
Body Parameters
| Parameter | Description |
|---|---|
| body Patch |
Response
| Code | Description |
|---|---|
| 200 Scale |
OK |