DescribeServiceAutoScaler - Platform For AI - Alibaba Cloud Documentation Center

Queries information about the Autoscaler configurations of a service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eas:DescribeServiceAutoScaler

get

*Service

acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The region ID of the service.	cn-shanghai
ServiceName	string	Yes	The service name. For more information about how to query the service name, see ListServices.	echo

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	40325405-579C-4D82****
ServiceName	string	The service name.	foo
MinReplica	integer	The minimum number of instances in the service.	3
MaxReplica	integer	The maximum number of instances in the service.	8
Behavior	object	The additional information about the Autoscaler policy, such as the interval of triggering Autoscaler.	{ "behavior": { "scaleDown": { "stabilizationWindowSeconds": 150 } } }
ScaleStrategies	array<object>	The auto scaling policies.
	object
metricName	string	The metric name. Valid values: QPS: the queries per second (QPS) for an individual instance. CPU: the CPU utilization.	QPS
threshold	number	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.	10
service	string	The service for which the metric is specified. If you do not set this parameter, the current service is specified by default.	demo_svc
CurrentMetrics	array<object>	The metrics.
	object
metricName	string	The metric name. Valid values: QPS CPU	QPS
value	number	The metric value.	10
service	string	The service for which the metric is specified.	demo_svc

Examples

Success response

JSON format

{
  "RequestId": "40325405-579C-4D82****",
  "ServiceName": "foo",
  "MinReplica": 3,
  "MaxReplica": 8,
  "Behavior": {
    "behavior": {
      "scaleDown": {
        "stabilizationWindowSeconds": 150
      }
    }
  },
  "ScaleStrategies": [
    {
      "metricName": "QPS",
      "threshold": 10,
      "service": "demo_svc"
    }
  ],
  "CurrentMetrics": [
    {
      "metricName": "QPS",
      "value": 10,
      "service": "demo_svc"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.