AI 助理
备案控制台
文档
输入文档关键字查找
首页 弹性伸缩 开发参考 API参考 API参考（2014-08-28） 伸缩组 DescribeScalingActivities

DescribeScalingActivities

更新时间：
产品详情
我的收藏

通过API DescribeScalingActivities查看伸缩活动的详情，了解通过定时任务、报警任务或手动执行伸缩规则等方式触发伸缩活动的结果。例如，您可以在伸缩活动详情页查看到伸缩活动的状态、活动起因、变化后总实例数等信息。

接口说明

  • 查询时可以指定伸缩组ID来查询该伸缩组下的所有伸缩活动。
  • 查询时可以通过伸缩活动的状态来过滤查询结果。
  • 可以查询30日内的伸缩活动。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeScalingActivities

系统规定参数。取值：DescribeScalingActivities。
RegionId String 是 cn-hangzhou

伸缩活动所属伸缩组的地域ID。
PageNumber Integer 否 1

伸缩活动列表的页码，起始值：1。

默认值：1。
PageSize Integer 否 10

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

默认值：10。
ScalingGroupId String 否 asg-bp18p2yfxow2dloq****

伸缩组的ID。

说明 调用该API时，ScalingGroupId和ScalingActivityId.N参数必须二选一进行配置，如果两个参数同时都不配置，则会报错。
StatusCode String 否 Successful

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

  • Successful：执行成功的伸缩活动。
  • Warning：部分执行成功的伸缩活动。
  • Failed：执行失败的伸缩活动。
  • InProgress：正在执行的伸缩活动。
  • Rejected：执行伸缩活动请求被拒绝。
ScalingActivityId.N String 否 asa-bp161xudmuxdzofe****

待查询伸缩活动的ID。

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

返回数据

名称

类型

示例值

描述
RequestId String CC107349-57B7-4405-B1BF-9BF5AF7F****

请求ID。
PageNumber Integer 1

当前页码。
PageSize Integer 10

每页行数。
TotalCount Integer 1

伸缩活动总数。
ScalingActivities Array of ScalingActivity

伸缩活动信息组成的集合。
ScalingActivity
Progress Integer 100

伸缩活动的运行进度。
ScalingInstanceNumber Integer 1
  • 如果伸缩活动类型为扩容，该参数表示本次伸缩活动中被创建或从停机回收状态启动的实例的个数。
  • 如果伸缩活动类型为缩容，该参数表示本次伸缩活动中被删除或进入停机回收状态的实例的个数。
AttachedCapacity String 0

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

执行完伸缩活动后，伸缩组中实例的总数。
ScalingGroupId String asg-bp18p2yfxow2dloq****

伸缩组的ID。
AutoCreatedCapacity String 2

执行完伸缩活动后，伸缩组中由伸缩组负责自动创建的实例的总数。
EndTime String 2020-09-10T09:54Z

伸缩活动的结束时间。
StartTime String 2020-09-10T09:54Z

伸缩活动的开始时间。
Description String Add \"1\" ECS instance

伸缩活动的描述信息。
StatusCode String Successful

伸缩活动的状态。可能值：

  • Successful：执行成功的伸缩活动。
  • Warning：部分执行成功的伸缩活动。
  • Failed：执行失败的伸缩活动。
  • InProgress：正在执行的伸缩活动。
  • Rejected：执行伸缩活动请求被拒绝。
Cause String A user requests to execute scaling rule \"asr-bp12tcnol686y1ik****\", changing the Total Capacity from \"1\" to \"2\".

触发伸缩活动的原因。
ScalingActivityId String asa-bp161xudmuxdzofe****

伸缩活动的ID。
StatusMessage String \"1\" ECS instances are added

伸缩活动的状态信息。
CreatedCapacity Integer 1

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

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

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

当前伸缩活动进入停机不收费状态的实例数量。
CreatedInstances Array of String [ "i-abc1", "i-abc2" ]

当前伸缩活动新建实例列表。
DestroyedInstances Array of String [ "i-abc1", "i-abc2" ]

当前伸缩活动释放实例列表。
StartedInstances Array of String [ "i-abc1", "i-abc2" ]

当前伸缩活动启动的停机不收费实例列表。
StoppedInstances Array of String [ "i-abc1", "i-abc2" ]

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

伸缩活动失败时的错误码。
ErrorMessage String The specified ECS resource is out of stock in this region. Please try again later.

伸缩活动失败时的错误信息。
Detail String "new ECS instances "i-j6c8ilerw, i-j6c8iler4mx" are created."

伸缩活动详细信息。
TriggerSourceType String Api

伸缩活动触发源类型。可能值：

  • Cms：通过报警任务方式触发伸缩活动。
  • Api：用户通过API方式触发伸缩活动。
  • Ess：通过系统任务方式触发伸缩活动。
TriggerSourceId String 2346366580*****

伸缩活动触发源ID。可能值：

  • Cms触发源ID：显示为报警任务ID。
  • Api触发源ID：显示为主账号UID或子账号UID。
  • Ess触发源ID：显示为空。
LifecycleHookContext Object

生命周期挂钩上下文信息。
DisableLifecycleHook Boolean false

伸缩活动是否禁用所有生命周期挂钩。可能值：

  • true：禁用。
  • false：不禁用。
IgnoredLifecycleHookIds Array of String ash-bp14zolna43z266bq***

伸缩活动禁用的生命周期挂钩ID列表。
ActivityMetadata String {\"goatscaler.io/managed\":\"true\"}

伸缩活动的元数据。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeScalingActivities
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&ScalingGroupId=asg-bp18p2yfxow2dloq****
&StatusCode=Successful
&ScalingActivityId=["asa-bp161xudmuxdzofe****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CC107349-57B7-4405-B1BF-9BF5AF7F****",
  "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" : [ "[ \"i-abc1\", \"i-abc2\" ]" ],
    "StartedInstances" : [ "[ \"i-abc1\", \"i-abc2\" ]" ],
    "StoppedInstances" : [ "[ \"i-abc1\", \"i-abc2\" ]" ],
    "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.\"",
    "TriggerSourceType" : "Api",
    "TriggerSourceId" : "2346366580*****",
    "LifecycleHookContext" : {
      "DisableLifecycleHook" : false,
      "IgnoredLifecycleHookIds" : [ "ash-bp14zolna43z266bq***" ]
    },
    "ActivityMetadata" : "{\\\"goatscaler.io/managed\\\":\\\"true\\\"}"
  } ]
}

错误码

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

上一篇：DescribeScalingInstances下一篇：DescribeScalingActivityDetail
文档推荐