CreateServiceAutoScaler - Platform For AI - Alibaba Cloud Documentation Center

Enables the Autoscaler feature and creates an Autoscaler controller for a service.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eas:CreateServiceAutoScaler	create	*Service `acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}`	none	none

Request syntax

POST /api/v2/services/{ClusterId}/{ServiceName}/autoscaler HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the region where the service is deployed.	cn-shanghai
ServiceName	string	Yes	The service name. For more information about how to query the service name, see ListServices .	foo
body	object	No	The request body.
min	integer	Yes	The minimum number of instances in the service.	2
max	integer	Yes	The maximum number of instances in the service. The value of max must be greater than the value of min.	8
scaleStrategies	array<object>	Yes	The service for which the metric is specified. If you do not set this parameter, the current service is specified by default.
	object	No
metricName	string	Yes	The name of the metric for triggering auto scaling. Valid values: qps: the queries per second (qps) for an individual instance. cpu: the cpu utilization. gpu[util]: gpu utilization.	qps
threshold	float	Yes	The threshold of the metric that triggers auto scaling. If you set metricName to qps, scale-out is triggered when the average qps for a single instance is greater than this threshold. If you set metricName to cpu, scale-out is triggered when the average cpu utilization for a single instance is greater than this threshold. If you set metricName to gpu, scale-out is triggered when the average cpu utilization for a single instance is greater than this threshold.	10
service	string	No	The service for which the metric is specified. If you do not set this parameter, the current service is specified by default.	demo_svc
behavior	object	No	The Autoscaler operation.
scaleUp	object	No	The scale-out operation.
stabilizationWindowSeconds	integer	No	The time window that is required before the scale-out operation is performed. The scale-out operation can be performed only if the specified metric exceeds the specified threshold in the specified time window. Default value: 0.	0
scaleDown	object	No	The scale-in operation.
stabilizationWindowSeconds	integer	No	The time window that is required before the scale-in operation is performed. The scale-in operation can be performed only if the specified metric drops below the specified threshold in the specified time window. Default value: 300.	300
onZero	object	No	The operation that reduces the number of instances to 0.
scaleDownGracePeriodSeconds	integer	No	The time window that is required before the number of instances is reduced to 0. The number of instances can be reduced to 0 only if no request is available or no traffic exists in the specified time window. Default value: 600.	600
scaleUpActivationReplicas	integer	No	The number of instances that you want to create at a time if the number of instances is 0. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	40325405-579C-4D82****
Message	string	The returned message.	Succeed to auto scale service [foo]

Examples

Sample success responses

JSONformat

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Succeed to auto scale service [foo]"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-05-17	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-09-16	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-09-16	The internal configuration of the API is changed, but the call is not affected	View Change Details