Chapter 3. MachineAutoscaler [autoscaling.openshift.io/v1beta1]
Chapter 3. MachineAutoscaler [autoscaling.openshift.io/v1beta1] Description MachineAutoscaler is the Schema for the machineautoscalers API Type object 3.1. 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 3.1.1. .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 3.1.2. .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. 3.1.3. .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 3.1.4. .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. 3.2. 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 3.2.1. /apis/autoscaling.openshift.io/v1beta1/machineautoscalers HTTP method GET Description list objects of kind MachineAutoscaler Table 3.1. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscalerList schema 401 - Unauthorized Empty 3.2.2. /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers HTTP method DELETE Description delete collection of MachineAutoscaler Table 3.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.3. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscalerList schema 401 - Unauthorized Empty HTTP method POST Description create a MachineAutoscaler Table 3.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 3.5. Body parameters Parameter Type Description body MachineAutoscaler schema Table 3.6. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscaler schema 201 - Created MachineAutoscaler schema 202 - Accepted MachineAutoscaler schema 401 - Unauthorized Empty 3.2.3. /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name} Table 3.7. Global path parameters Parameter Type Description name string name of the MachineAutoscaler HTTP method DELETE Description delete a MachineAutoscaler Table 3.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 3.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 3.10. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscaler schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified MachineAutoscaler Table 3.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 3.12. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscaler schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified MachineAutoscaler Table 3.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 3.14. Body parameters Parameter Type Description body MachineAutoscaler schema Table 3.15. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscaler schema 201 - Created MachineAutoscaler schema 401 - Unauthorized Empty 3.2.4. /apis/autoscaling.openshift.io/v1beta1/namespaces/{namespace}/machineautoscalers/{name}/status Table 3.16. Global path parameters Parameter Type Description name string name of the MachineAutoscaler HTTP method GET Description read status of the specified MachineAutoscaler Table 3.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 3.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 3.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 3.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 3.21. Body parameters Parameter Type Description body MachineAutoscaler schema Table 3.22. HTTP responses HTTP code Reponse body 200 - OK MachineAutoscaler schema 201 - Created MachineAutoscaler schema 401 - Unauthorized Empty