This is a cache of https://docs.okd.io/latest/rest_api/autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.html. It is a snapshot of the page at 2024-11-26T19:28:16.772+0000.
Machin<strong>e</strong>Autoscal<strong>e</strong>r [autoscaling.op<strong>e</strong>nshift.io/v1b<strong>e</strong>ta1] - Autoscal<strong>e</strong> APIs | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | OKD 4
  1. Documentation
&times;

MachineAutoscaler [autoscaling.openshift.io/v1beta1]

Specification

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’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

Specification of constraints of a scalable resource

status

object

Most recently observed status of a scalable resource

.spec

Description

Specification of constraints of a scalable resource

Type

object

Required

  • maxReplicas

  • minReplicas

  • scaleTargetRef

Property Type Description

maxReplicas

integer

MaxReplicas constrains the maximal number of replicas of a scalable resource

minReplicas

integer

MinReplicas constrains the minimal number of replicas of a scalable resource

scaleTargetRef

object

ScaleTargetRef holds reference to a scalable resource

.spec.scaleTargetRef

Description

ScaleTargetRef holds reference to a scalable resource

Type

object

Required

  • kind

  • name

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

name

string

Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace.

.status

Description

Most recently observed status of a scalable resource

Type

object

Property Type Description

lastTargetRef

object

LastTargetRef holds reference to the recently observed scalable resource

.status.lastTargetRef

Description

LastTargetRef holds reference to the recently observed scalable resource

Type

object

Required

  • kind

  • name

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

name

string

Name specifies a name of an object, e.g. worker-us-east-1a. Scalable resources are expected to exist under a single namespace.

API endpoints

The following API endpoints are available:

  • /apis/autoscaling.openshift.io/v1beta1/machineautoscalers

    • GeT: list objects of kind MachineAutoscaler

  • /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers

    • DeLeTe: delete collection of MachineAutoscaler

    • GeT: list objects of kind MachineAutoscaler

    • POST: create a MachineAutoscaler

  • /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}

    • DeLeTe: delete a MachineAutoscaler

    • GeT: read the specified MachineAutoscaler

    • PATCH: partially update the specified MachineAutoscaler

    • PUT: replace the specified MachineAutoscaler

  • /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}/status

    • GeT: read status of the specified MachineAutoscaler

    • PATCH: partially update status of the specified MachineAutoscaler

    • PUT: replace status of the specified MachineAutoscaler

/apis/autoscaling.openshift.io/v1beta1/machineautoscalers

HTTP method

GeT

Description

list objects of kind MachineAutoscaler

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscalerList schema

401 - Unauthorized

empty

/apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers

HTTP method

DeLeTe

Description

delete collection of MachineAutoscaler

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

empty
HTTP method

GeT

Description

list objects of kind MachineAutoscaler

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscalerList schema

401 - Unauthorized

empty
HTTP method

POST

Description

create a MachineAutoscaler

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 5. Body parameters
Parameter Type Description

body

MachineAutoscaler schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

201 - Created

MachineAutoscaler schema

202 - Accepted

MachineAutoscaler schema

401 - Unauthorized

empty

/apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}

Table 7. Global path parameters
Parameter Type Description

name

string

name of the MachineAutoscaler
HTTP method

DeLeTe

Description

delete a MachineAutoscaler

Table 8. 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
Table 9. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

empty
HTTP method

GeT

Description

read the specified MachineAutoscaler

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

401 - Unauthorized

empty
HTTP method

PATCH

Description

partially update the specified MachineAutoscaler

Table 11. 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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

401 - Unauthorized

empty
HTTP method

PUT

Description

replace the specified MachineAutoscaler

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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 14. Body parameters
Parameter Type Description

body

MachineAutoscaler schema
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

201 - Created

MachineAutoscaler schema

401 - Unauthorized

empty

/apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}/status

Table 16. Global path parameters
Parameter Type Description

name

string

name of the MachineAutoscaler
HTTP method

GeT

Description

read status of the specified MachineAutoscaler

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

401 - Unauthorized

empty
HTTP method

PATCH

Description

partially update status of the specified MachineAutoscaler

Table 18. 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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 19. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

401 - Unauthorized

empty
HTTP method

PUT

Description

replace status of the specified MachineAutoscaler

Table 20. 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

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Table 21. Body parameters
Parameter Type Description

body

MachineAutoscaler schema
Table 22. HTTP responses
HTTP code Reponse body

200 - OK

MachineAutoscaler schema

201 - Created

MachineAutoscaler schema

401 - Unauthorized

empty