DescribeAutoScalingConfig API Reference - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Invokes the DescribeAutoScalingConfig operation to query the elastic scaling feature configuration of an instance.

Operation description

Before you begin:

Use the latest version of the Alibaba Cloud or DAS SDK.
When calling DAS by using the SDK, set the region 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

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	pc-2ze1prap1k46r****

Response elements

Element	Type	Description	Example
	object
Code	string	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, 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 is successful. Valid values: true: The request is successful. false: The request fails.	true
Data	object	The elastic scaling feature configuration of the instance.
Spec	object	The specification elastic scaling feature configuration.
Upgrade	boolean	Indicates whether automatic specification scale-up is enabled. Valid values: true: Enabled. false: Disabled.	true
CpuUsageUpperThreshold	integer	The average CPU utilization threshold that triggers automatic specification scale-up. Unit: %.	70
MemUsageUpperThreshold	integer	The average memory utilization threshold that triggers automatic specification scale-up. Unit: %.	70
MaxSpec	string	The maximum specification for automatic scale-up. For details, refer to the product specification documentation for each database instance: For PolarDB for MySQL Cluster Edition, see Compute node specifications. For ApsaraDB RDS for MySQL high-availability series with cloud disks, see Product specifications. For Redis community cloud disk edition, see Instance specifications. For PolarDB for MySQL Cluster Edition, see Compute node specifications. For ApsaraDB RDS for MySQL high-availability series with cloud disks, see Product specifications.	polar.mysql.x8.12xlarge
MaxReadOnlyNodes	integer	The maximum number of read-only nodes for the instance.	10
ObservationWindowSize	string	The observation window. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 5m indicates 5 minutes.	5m
CoolDownTime	string	The cool-down period. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 5m indicates 5 minutes.	5m
Downgrade	boolean	Indicates whether automatic specification scale-down is enabled. Valid values: true: Enabled. false: Disabled.	true
Storage	object	The Automatic storage scaling feature configuration of the instance.
Upgrade	boolean	Indicates whether automatic storage scaling is enabled. Valid values: true: Enabled. false: Disabled.	true
DiskUsageUpperThreshold	integer	The average storage utilization threshold that triggers automatic storage scaling. Unit: %.	70
MaxStorage	integer	The maximum storage capacity. Unit: GB.	32000
Resource	object	The local resource elastic scaling feature configuration of the instance.
Enable	boolean	Indicates whether local resource elastic scaling is enabled. Valid values: true: Enabled. false: Disabled.	true
CpuUsageUpperThreshold	integer	The average CPU utilization threshold that triggers automatic local resource scale-up. Unit: %.	70
CpuStep	integer	The CPU scale-up increment.	2
UpgradeObservationWindowSize	string	The scale-up observation window. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 5m indicates 5 minutes.	5m
DowngradeObservationWindowSize	string	The scale-down observation window. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 5m indicates 5 minutes.	5m
Shard	object	The shard elastic scaling feature configuration of the instance.
Upgrade	boolean	Indicates whether automatic shard addition is enabled. Valid values: true: Enabled. false: Disabled.	true
MemUsageUpperThreshold	integer	The average memory utilization threshold that triggers automatic shard addition. Unit: %.	70
MaxShards	integer	The maximum total number of shards for the instance.	16
UpgradeObservationWindowSize	string	The observation window for automatic shard addition. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 5m indicates 5 minutes.	5m
Downgrade	boolean	Indicates whether automatic shard removal is enabled. Valid values: true: Enabled. false: Disabled.	true
MemUsageLowerThreshold	integer	The average memory utilization threshold that triggers automatic shard removal. Unit: %.	30
MinShards	integer	The minimum total number of shards for the instance.	4
DowngradeObservationWindowSize	string	The observation window for automatic shard removal. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 1d indicates 1 day.	1d
Bandwidth	object	The bandwidth elastic scaling feature configuration of the instance.
Upgrade	boolean	Indicates whether automatic bandwidth upgrade is enabled. Valid values: true: Enabled. false: Disabled.	true
BandwidthUsageUpperThreshold	integer	The average bandwidth usage threshold that triggers automatic bandwidth upgrade. Unit: %.	70
ObservationWindowSize	string	The observation window for automatic bandwidth upgrade. The value consists of a number and a time unit suffix. The time unit suffixes are: s: seconds. m: minutes. h: hours. d: days. Note For example, 5m indicates 5 minutes.	5m
Downgrade	boolean	Indicates whether automatic bandwidth downgrade is enabled. Valid values: true: Enabled. false: Disabled.	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.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.