All Products
Search

This Product

    Database Autonomy Service:DescribeAutoScalingConfig

    Document Center

    Database Autonomy Service:DescribeAutoScalingConfig

    Last Updated:Apr 14, 2026

    Queries the configurations of the auto scaling feature for an instance.

    Operation description

    Before you call this operation, take note of the following items:

    • If you use an Alibaba Cloud SDK or a Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.

    • If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.

    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

    hdm:DescribeAutoScalingConfig

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    pc-2ze1prap1k46r****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    Code

    string

    The HTTP status code returned.

    200
    Message

    string

    The returned message.

    Note

    If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.

    Successful
    RequestId

    string

    The request ID.

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    string

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true
    Data

    object

    The configurations of the auto scaling feature for instances.

    Spec

    object

    The configurations of the auto scaling feature for specifications.

    Upgrade

    boolean

    Indicates whether the automatic specification scale-up feature is enabled. Valid values:

    • true

    • false

    true
    CpuUsageUpperThreshold

    integer

    The average CPU utilization threshold that triggers automatic specification scale-up. Unit: %.

    70
    MemUsageUpperThreshold

    integer

    The average memory usage threshold that triggers automatic specification scale-up. Unit: %.

    70
    MaxSpec

    string

    The maximum specifications to which the cluster can be scaled up. For more information about the specifications of each type of supported database instances, see the following topics:

    polar.mysql.x8.12xlarge
    MaxReadOnlyNodes

    integer

    The maximum number of read-only nodes of the instance.

    10
    ObservationWindowSize

    string

    The observation window. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 5m indicates 5 minutes.

    5m
    CoolDownTime

    string

    The quiescent period. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 5m indicates 5 minutes.

    5m
    Downgrade

    boolean

    Indicates whether the automatic specification scale-down feature is enabled. Valid values:

    • true

    • false

    true
    Storage

    object

    The configurations of the automatic storage expansion feature.

    Upgrade

    boolean

    Indicates whether the automatic storage expansion feature is enabled. Valid values:

    • true

    • false

    true
    DiskUsageUpperThreshold

    integer

    The average storage usage threshold that triggers automatic storage expansion. Unit: %.

    70
    MaxStorage

    integer

    The maximum storage size. Unit: GB.

    32000
    Resource

    object

    The configurations of the auto scaling feature for local resources.

    Enable

    boolean

    Indicates whether the auto scaling feature is enabled for local resources. Valid values:

    • true

    • false

    true
    CpuUsageUpperThreshold

    integer

    The average CPU utilization threshold that triggers automatic scale-out of local resources. Unit: %.

    70
    CpuStep

    integer

    The scale-out step size of CPU.

    2
    UpgradeObservationWindowSize

    string

    The observation window of the automatic scale-out feature for local resources. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 5m indicates 5 minutes.

    5m
    DowngradeObservationWindowSize

    string

    The observation window of the automatic scale-in feature for local resources. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 5m indicates 5 minutes.

    5m
    Shard

    object

    The configurations of the auto scaling feature for shards.

    Upgrade

    boolean

    Indicates whether the feature of automatically adding shards is enabled. Valid values:

    • true

    • false

    true
    MemUsageUpperThreshold

    integer

    The average memory usage threshold that triggers automatic adding of shards. Unit: %.

    70
    MaxShards

    integer

    The maximum number of shards in the instance.

    16
    UpgradeObservationWindowSize

    string

    The observation window of the feature of automatically adding shards. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 5m indicates 5 minutes.

    5m
    Downgrade

    boolean

    Indicates whether the feature of automatically removing shards is enabled. Valid values:

    • true

    • false

    true
    MemUsageLowerThreshold

    integer

    The average memory usage threshold that triggers automatic removal of shards. Unit: %.

    30
    MinShards

    integer

    The minimum number of shards in the instance.

    4
    DowngradeObservationWindowSize

    string

    The observation window of the feature of automatically removing shards. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 1d indicates one day.

    1d
    Bandwidth

    object

    The configurations of the automatic bandwidth adjustment feature.

    Upgrade

    boolean

    Indicates whether the automatic bandwidth adjustment feature is enabled. Valid values:

    • true

    • false

    true
    BandwidthUsageUpperThreshold

    integer

    The average bandwidth usage threshold that triggers automatic bandwidth adjustment. Unit: %.

    70
    ObservationWindowSize

    string

    The observation window of the automatic bandwidth adjustment feature. The return value consists of a numeric value and a time unit suffix. Valid values of the time unit suffix:

    • s: seconds.

    • m: minutes.

    • h: hours.

    • d: days.

    Note

    A value of 5m indicates 5 minutes.

    5m
    Downgrade

    boolean

    Indicates whether the automatic bandwidth downgrade feature is enabled. Valid values:

    • true

    • false

    true
    BandwidthUsageLowerThreshold

    integer

    The average bandwidth usage threshold that triggers automatic bandwidth downgrade. Unit: %.

    30

    Examples

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "Spec": {
      "Upgrade": true,
      "CpuUsageUpperThreshold": 70,
      "MemUsageUpperThreshold": 70,
      "MaxSpec": "polar.mysql.x8.12xlarge",
      "MaxReadOnlyNodes": 10,
      "ObservationWindowSize": "5m",
      "CoolDownTime": "5m",
      "Downgrade": true
    },
    "Storage": {
      "Upgrade": true,
      "DiskUsageUpperThreshold": 70,
      "MaxStorage": 32000
    },
    "Resource": {
      "Enable": true,
      "CpuUsageUpperThreshold": 70,
      "CpuStep": 2,
      "UpgradeObservationWindowSize": "5m",
      "DowngradeObservationWindowSize": "5m"
    },
    "Shard": {
      "Upgrade": true,
      "MemUsageUpperThreshold": 70,
      "MaxShards": 16,
      "UpgradeObservationWindowSize": "5m",
      "Downgrade": true,
      "MemUsageLowerThreshold": 30,
      "MinShards": 4,
      "DowngradeObservationWindowSize": "1d"
    },
    "Bandwidth": {
      "Upgrade": true,
      "BandwidthUsageUpperThreshold": 70,
      "ObservationWindowSize": "5m",
      "Downgrade": true,
      "BandwidthUsageLowerThreshold": 30
    }
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.