All Products
Search
Document Center

Platform For AI:DescribeServiceAutoScaler

Last Updated:Nov 22, 2024

Queries information about the Autoscaler configurations of 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
eas:DescribeServiceAutoScalerget
*Service
acs:eas:{#regionId}:{#accountId}:service/{#ServiceName}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The region ID of the service.

cn-shanghai
ServiceNamestringYes

The service name. For more information about how to query the service name, see ListServices .

echo

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

40325405-579C-4D82****
ServiceNamestring

The service name.

foo
MinReplicainteger

The minimum number of instances in the service.

3
MaxReplicainteger

The maximum number of instances in the service.

8
Behaviorobject

The additional information about the Autoscaler policy, such as the interval of triggering Autoscaler.

{ "behavior": { "scaleDown": { "stabilizationWindowSeconds": 150 } } }
ScaleStrategiesarray<object>

The auto scaling policies.

ScaleStrategyobject
metricNamestring

The metric name. Valid values:

  • QPS: the queries per second (QPS) for an individual instance.
  • CPU: the CPU utilization.
QPS
thresholdfloat

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
servicestring

The service for which the metric is specified. If you do not set this parameter, the current service is specified by default.

demo_svc
CurrentMetricsarray<object>

The metrics.

CurrentMetricobject
metricNamestring

The metric name. Valid values:

  • QPS
  • CPU
qps
valuefloat

The metric value.

10
servicestring

The service for which the metric is specified.

demo_svc

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2022-09-16The response structure of the API has changedView Change Details
2022-09-16The response structure of the API has changedView Change Details