文档

DescribeScalingActivities - 查询伸缩活动

更新时间:

查询伸缩活动。

接口说明

查询时可以指定伸缩组 ID 来查询该伸缩组下的所有伸缩活动。

查询时可以通过伸缩活动的状态来过滤查询结果。

可以查询 30 日内的伸缩活动。

调试

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

调试

授权信息

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

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

请求参数

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

伸缩活动所属伸缩组的地域 ID。

cn-hangzhou
PageNumberinteger

伸缩活动列表的页码,起始值:1。

默认值:1。

1
PageSizeinteger

分页查询时设置的每页行数,最大值:50。

默认值:10。

10
ScalingGroupIdstring

伸缩组的 ID。

说明 调用该 API 时,ScalingGroupIdScalingActivityId.N参数必须二选一进行配置,如果两个参数同时都不配置,则会报错。
asg-bp18p2yfxow2dloq****
StatusCodestring

伸缩活动的状态。取值范围:

  • Successful:执行成功的伸缩活动。
  • Warning:部分执行成功的伸缩活动。
  • Failed:执行失败的伸缩活动。
  • InProgress:正在执行的伸缩活动。
  • Rejected:执行伸缩活动请求被拒绝。
Successful
ScalingActivityIdsarray

待查询伸缩活动的 ID。

说明 调用该 API 时,ScalingGroupIdScalingActivityId.N参数必须二选一进行配置,如果两个参数同时都不配置,则会报错。
string

待查询伸缩活动的 ID。

说明 调用该 API 时,ScalingGroupIdScalingActivityId.N参数必须二选一进行配置,如果两个参数同时都不配置,则会报错。
asa-bp161xudmuxdzofe****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

CC107349-57B7-4405-B1BF-9BF5AF7F2A46
PageNumberinteger

当前页码。

1
PageSizeinteger

每页行数。

10
TotalCountinteger

伸缩活动总数。

1
ScalingActivitiesobject []

伸缩活动信息组成的集合。

Progressinteger

伸缩活动的运行进度。

100
ScalingInstanceNumberinteger

如果伸缩活动类型为扩容,该参数表示本次伸缩活动中被创建或从停机回收状态启动的实例的个数。

如果伸缩活动类型为缩容,该参数表示本次伸缩活动中被删除或进入停机回收状态的实例的个数。

1
AttachedCapacitystring

执行完伸缩活动后,伸缩组中用户手动添加的实例的总数。

0
TotalCapacitystring

执行完伸缩活动后,伸缩组中实例的总数。

2
ScalingGroupIdstring

伸缩组的 ID。

asg-bp18p2yfxow2dloq****
AutoCreatedCapacitystring

执行完伸缩活动后,伸缩组中由伸缩组负责自动创建的实例的总数。

2
EndTimestring

伸缩活动的结束时间。

2020-09-10T09:54Z
StartTimestring

伸缩活动的开始时间。

2020-09-10T09:54Z
Descriptionstring

伸缩活动的描述信息。

Add \"1\" ECS instance
StatusCodestring

伸缩活动的状态,可能值:

  • Successful:执行成功的伸缩活动。
  • Warning:部分执行成功的伸缩活动。
  • Failed:执行失败的伸缩活动。
  • InProgress:正在执行的伸缩活动。
  • Rejected:执行伸缩活动请求被拒绝。
Successful
Causestring

触发伸缩活动的原因。

A user requests to execute scaling rule \"asr-bp12tcnol686y1ik****\", changing the Total Capacity from \"1\" to \"2\".
ScalingActivityIdstring

伸缩活动的 ID。

asa-bp161xudmuxdzofe****
StatusMessagestring

伸缩活动的状态信息。

\"1\" ECS instances are added
CreatedCapacityinteger

当前伸缩活动新建的实例数量。

1
DestroyedCapacityinteger

当前伸缩活动释放的实例数量。

1
StartedCapacityinteger

当前伸缩活动从停机不收费状态启动的实例数量。

1
StoppedCapacityinteger

当前伸缩活动进入停机不收费状态的实例数量。

1
CreatedInstancesarray

当前伸缩活动新建实例列表。

string

当前伸缩活动新建实例列表。

["i-abc1","i-abc2"]
DestroyedInstancesarray

当前伸缩活动释放实例列表。

string

当前伸缩活动释放实例列表。

[ "i-abc1", "i-abc2" ]
StartedInstancesarray

当前伸缩活动启动的停机不收费实例列表。

string

当前伸缩活动启动的停机不收费实例列表。

[ "i-abc1", "i-abc2" ]
StoppedInstancesarray

当前伸缩活动进入停机不收费状态实例列表。

string

当前伸缩活动进入停机不收费状态实例列表。

[ "i-abc1", "i-abc2" ]
ErrorCodestring

伸缩活动失败时的错误码。

OperationDenied.NoStock
ErrorMessagestring

伸缩活动失败时的错误信息。

The specified ECS resource is out of stock in this region. Please try again later.
Detailstring

伸缩活动详细信息。

"new ECS instances "i-j6c8ilerw, i-j6c8iler4mx" are created."

示例

正常返回示例

JSON格式

{
  "RequestId": "CC107349-57B7-4405-B1BF-9BF5AF7F2A46",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "ScalingActivities": [
    {
      "Progress": 100,
      "ScalingInstanceNumber": 1,
      "AttachedCapacity": "0",
      "TotalCapacity": "2",
      "ScalingGroupId": "asg-bp18p2yfxow2dloq****",
      "AutoCreatedCapacity": "2",
      "EndTime": "2020-09-10T09:54Z",
      "StartTime": "2020-09-10T09:54Z",
      "Description": "Add \\\"1\\\" ECS instance",
      "StatusCode": "Successful",
      "Cause": "A user requests to execute scaling rule \\\"asr-bp12tcnol686y1ik****\\\", changing the Total Capacity from \\\"1\\\" to \\\"2\\\".",
      "ScalingActivityId": "asa-bp161xudmuxdzofe****",
      "StatusMessage": "\\\"1\\\" ECS instances are added",
      "CreatedCapacity": 1,
      "DestroyedCapacity": 1,
      "StartedCapacity": 1,
      "StoppedCapacity": 1,
      "CreatedInstances": [
        "[\"i-abc1\",\"i-abc2\"]"
      ],
      "DestroyedInstances": [
        "[\n      \"i-abc1\",\n      \"i-abc2\"\n]"
      ],
      "StartedInstances": [
        "[\n      \"i-abc1\",\n      \"i-abc2\"\n]"
      ],
      "StoppedInstances": [
        "[\n      \"i-abc1\",\n      \"i-abc2\"\n]"
      ],
      "ErrorCode": "OperationDenied.NoStock",
      "ErrorMessage": "The specified ECS resource is out of stock in this region. Please try again later.",
      "Detail": "\"new ECS instances \"i-j6c8ilerw, i-j6c8iler4mx\" are created.\""
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-12-16OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈