文档

DescribeAutoScalingConfig - 查询实例弹性伸缩功能配置信息

更新时间:

调用DescribeAutoScalingConfig接口,查询实例弹性伸缩功能配置信息。

接口说明

使用该接口需满足以下前提条件:

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:DescribeAutoScalingConfigget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

pc-2ze1prap1k46r****

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

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

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true
Dataobject

实例弹性伸缩功能配置信息。

Specobject

规格弹性伸缩功能配置信息。

Upgradeboolean

规格自动扩容是否开启:

  • true:是。
  • false:否。
true
CpuUsageUpperThresholdinteger

触发规格自动扩容的 CPU 平均利用率阈值,单位为%。

70
MemUsageUpperThresholdinteger

触发规格自动扩容的内存平均利用率阈值,单位为%。

70
MaxSpecstring

自动扩容的规格上限。详情请参见各数据库实例的产品规格文档:

polar.mysql.x8.12xlarge
MaxReadOnlyNodesinteger

实例只读节点数的最大值。

10
ObservationWindowSizestring

观测窗口。 返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 5m 表示 5 分钟。
5m
CoolDownTimestring

静默期。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 5m 表示 5 分钟。
5m
Downgradeboolean

规格自动回缩是否开启:

  • true:是。
  • false:否。
true
Storageobject

实例存储自动扩容功能配置信息。

Upgradeboolean

存储自动扩容是否开启:

  • true:是。
  • false:否。
true
DiskUsageUpperThresholdinteger

触发存储自动扩容的存储空间平均利用率阈值,单位为%。

70
MaxStorageinteger

存储空间上限,单位为 GB。

32000
Resourceobject

实例本地资源弹性伸缩功能配置信息。

Enableboolean

本地资源弹性伸缩是否开启:

  • true:是。
  • false:否。
true
CpuUsageUpperThresholdinteger

触发本地资源自动扩容的 CPU 平均利用率阈值,单位为%。

70
CpuStepinteger

CPU 扩容步长。

2
UpgradeObservationWindowSizestring

扩容观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 5m 表示 5 分钟。
5m
DowngradeObservationWindowSizestring

缩容观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 5m 表示 5 分钟。
5m
Shardobject

实例分片弹性伸缩功能配置信息。

Upgradeboolean

自动增加分片是否开启:

  • true:是。
  • false:否。
true
MemUsageUpperThresholdinteger

触发自动增加分片的内存平均利用率阈值,单位为%。

70
MaxShardsinteger

实例总分片数的最大值。

16
UpgradeObservationWindowSizestring

自动增加分片观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 5m 表示 5 分钟。
5m
Downgradeboolean

自动减少分片是否开启:

  • true:是。
  • false:否。
true
MemUsageLowerThresholdinteger

触发自动减少分片的内存平均利用率阈值,单位为%。

30
MinShardsinteger

实例总分片数的最小值。

4
DowngradeObservationWindowSizestring

自动减少分片观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 1d 表示 1 天。
1d
Bandwidthobject

实例带宽弹性伸缩功能配置信息。

Upgradeboolean

带宽自动扩展是否开启:

  • true:是。
  • false:否。
true
BandwidthUsageUpperThresholdinteger

触发带宽自动扩展的带宽平均使用率阈值,单位为%。

70
ObservationWindowSizestring

带宽自动扩展的观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:

  • s:表示秒。
  • m:表示分钟。
  • h:表示小时。
  • d:表示天。
说明 例如,返回 5m 表示 5 分钟。
5m
Downgradeboolean

带宽自动回缩是否开启:

  • true:是。
  • false:否。
true
BandwidthUsageLowerThresholdinteger

触发带宽自动回缩的带宽平均使用率阈值,单位为%。

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错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史