调用DescribeAutoScalingConfig接口,查询实例弹性伸缩功能配置信息。
接口说明
使用该接口需满足以下前提条件:
使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hdm:DescribeAutoScalingConfig |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
pc-2ze1prap1k46r**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
返回的状态码。 |
200 |
| Message |
string |
请求返回消息。 说明
请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Successful |
| RequestId |
string |
请求 ID。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
请求是否执行成功:
|
true |
| Data |
object |
实例弹性伸缩功能配置信息。 |
|
| Spec |
object |
规格弹性伸缩功能配置信息。 |
|
| Upgrade |
boolean |
规格自动扩容是否开启:
|
true |
| CpuUsageUpperThreshold |
integer |
触发规格自动扩容的 CPU 平均利用率阈值,单位为%。 |
70 |
| MemUsageUpperThreshold |
integer |
触发规格自动扩容的内存平均利用率阈值,单位为%。 |
70 |
| MaxSpec |
string |
自动扩容的规格上限。详情请参见各数据库实例的产品规格文档: |
polar.mysql.x8.12xlarge |
| MaxReadOnlyNodes |
integer |
实例只读节点数的最大值。 |
10 |
| ObservationWindowSize |
string |
观测窗口。 返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 5m 表示 5 分钟。 |
5m |
| CoolDownTime |
string |
静默期。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 5m 表示 5 分钟。 |
5m |
| Downgrade |
boolean |
规格自动回缩是否开启:
|
true |
| Storage |
object |
实例存储自动扩容功能配置信息。 |
|
| Upgrade |
boolean |
存储自动扩容是否开启:
|
true |
| DiskUsageUpperThreshold |
integer |
触发存储自动扩容的存储空间平均利用率阈值,单位为%。 |
70 |
| MaxStorage |
integer |
存储空间上限,单位为 GB。 |
32000 |
| Resource |
object |
实例本地资源弹性伸缩功能配置信息。 |
|
| Enable |
boolean |
本地资源弹性伸缩是否开启:
|
true |
| CpuUsageUpperThreshold |
integer |
触发本地资源自动扩容的 CPU 平均利用率阈值,单位为%。 |
70 |
| CpuStep |
integer |
CPU 扩容步长。 |
2 |
| UpgradeObservationWindowSize |
string |
扩容观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 5m 表示 5 分钟。 |
5m |
| DowngradeObservationWindowSize |
string |
缩容观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 5m 表示 5 分钟。 |
5m |
| Shard |
object |
实例分片弹性伸缩功能配置信息。 |
|
| Upgrade |
boolean |
自动增加分片是否开启:
|
true |
| MemUsageUpperThreshold |
integer |
触发自动增加分片的内存平均利用率阈值,单位为%。 |
70 |
| MaxShards |
integer |
实例总分片数的最大值。 |
16 |
| UpgradeObservationWindowSize |
string |
自动增加分片观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 5m 表示 5 分钟。 |
5m |
| Downgrade |
boolean |
自动减少分片是否开启:
|
true |
| MemUsageLowerThreshold |
integer |
触发自动减少分片的内存平均利用率阈值,单位为%。 |
30 |
| MinShards |
integer |
实例总分片数的最小值。 |
4 |
| DowngradeObservationWindowSize |
string |
自动减少分片观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 1d 表示 1 天。 |
1d |
| Bandwidth |
object |
实例带宽弹性伸缩功能配置信息。 |
|
| Upgrade |
boolean |
带宽自动扩展是否开启:
|
true |
| BandwidthUsageUpperThreshold |
integer |
触发带宽自动扩展的带宽平均使用率阈值,单位为%。 |
70 |
| ObservationWindowSize |
string |
带宽自动扩展的观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:
说明
例如,返回 5m 表示 5 分钟。 |
5m |
| Downgrade |
boolean |
带宽自动回缩是否开启:
|
true |
| BandwidthUsageLowerThreshold |
integer |
触发带宽自动回缩的带宽平均使用率阈值,单位为%。 |
30 |
示例
正常返回示例
JSON格式
{
"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
}
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
| 403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。