All Products
Search

This Product

    Database Autonomy Service:DescribeAutoScalingConfig

    Document Center

    Database Autonomy Service:DescribeAutoScalingConfig

    Last Updated:Apr 25, 2024

    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.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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
    hdm:DescribeAutoScalingConfigRead
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The instance ID.

    		pc-2ze1prap1k46r****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The HTTP status code returned.

    		200
    Messagestring

    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
    RequestIdstring

    The request ID.

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

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    Dataobject

    The configurations of the auto scaling feature.

    Specobject

    The configurations of the auto scaling feature for specifications.

    Upgradeboolean

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

    • true
    • false
    		true
    CpuUsageUpperThresholdinteger

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

    		70
    MemUsageUpperThresholdinteger

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

    		70
    MaxSpecstring

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

    		polar.mysql.x8.12xlarge
    MaxReadOnlyNodesinteger

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

    		10
    ObservationWindowSizestring

    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
    CoolDownTimestring

    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
    Downgradeboolean

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

    • true
    • false
    		true
    Storageobject

    The configurations of the automatic storage expansion feature.

    Upgradeboolean

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

    • true
    • false
    		true
    DiskUsageUpperThresholdinteger

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

    		70
    MaxStorageinteger

    The maximum storage size. Unit: GB.

    		32000
    Resourceobject

    The configurations of the auto scaling feature for local resources.

    Enableboolean

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

    • true
    • false
    		true
    CpuUsageUpperThresholdinteger

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

    		70
    CpuStepinteger

    The scale-out step size of CPU.

    		2
    UpgradeObservationWindowSizestring

    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
    DowngradeObservationWindowSizestring

    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
    Shardobject

    The configurations of the auto scaling feature for shards.

    Upgradeboolean

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

    • true
    • false
    		true
    MemUsageUpperThresholdinteger

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

    		70
    MaxShardsinteger

    The maximum number of shards in the instance.

    		16
    UpgradeObservationWindowSizestring

    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
    Downgradeboolean

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

    • true
    • false
    		true
    MemUsageLowerThresholdinteger

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

    		30
    MinShardsinteger

    The minimum number of shards in the instance.

    		4
    DowngradeObservationWindowSizestring

    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
    Bandwidthobject

    The configurations of the automatic bandwidth adjustment feature.

    Upgradeboolean

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

    • true
    • false
    		true
    BandwidthUsageUpperThresholdinteger

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

    		70
    ObservationWindowSizestring

    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
    Downgradeboolean

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

    • true
    • false
    		true
    BandwidthUsageLowerThresholdinteger

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

    		30

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError message
    400InvalidParamsThe request parameters are invalid.
    403NoPermissionYou are not authorized to do this action.

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

    Change history

    Change timeSummary of changesOperation
    No change history