DescribeLifecycleActions

调用DescribeLifecycleActions,通过指定伸缩活动的ID、查询凭证、MaxResults等配置参数,查看伸缩活动发生时,生命周期挂钩执行操作的状态、标识符、挂起的ECS实例的ID等信息。

接口说明

如果伸缩组发生了和生命周期挂钩适用类型一致的伸缩活动,每个生命周期挂钩都会触发一次生命周期操作,生命周期操作有三种状态:

  • Pending:挂起中。表示ECS实例仍处于挂起中状态。
  • Timeout:已超时。表示已超过生命周期挂钩的超时时间,自动结束了ECS实例的挂起中状态。
  • Completed:已处理。表示您手动提前结束了ECS实例的挂起中状态。

如果在创建生命周期挂钩时没有设置后续动作,例如在结束挂起后触发执行指定的OOS模板。您可以调用本接口获取当前伸缩活动对应生命周期操作的标识符,以便自行定制后续动作。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLifecycleActions

系统规定参数。取值:DescribeLifecycleActions

ScalingActivityId String asa-bp17mug9t0pegagw****

伸缩活动的ID。

LifecycleActionStatus String Pending

生命周期操作的状态。取值范围:

  • Pending:挂起中。表示ECS实例仍处于挂起中状态。
  • Timeout:已超时。表示已到达生命周期挂钩的超时时间,自动结束ECS实例的挂起中状态。
  • Completed:已处理。表示您手动提前结束了ECS实例的挂起中状态。
NextToken String AAAAAcSz4VTb1Nq****

查询凭证,用于指定开始查询的位置。

例如上次查询10条生命周期操作后,本次从第11条生命周期操作开始查询。取值为上次调用本接口返回的NextToken参数值,如果不填写取值则表示从头开始查询。

MaxResults Integer 10

设置单页查询的最大条目数。取值范围:1~50。

默认值:10。

RegionId String cn-qingdao

伸缩组所属的地域ID。

返回数据

名称

类型

示例值

描述

NextToken String AAAAAcSz4VTb1Nq****

本次调用返回的查询凭证。

RequestId String 42A742EB-FCF3-459E-9C62-E107048C17E3

请求ID。

TotalCount Integer 3

本次查询到的生命周期操作的总数。

MaxResults Integer 3

单页查询的最大条目数。

LifecycleActions Array of LifecycleAction

各个生命周期挂钩对应的生命周期操作列表。

LifecycleAction
LifecycleHookId String ash-bp18uoft0deax0f7****

生命周期挂钩的ID。

LifecycleActionToken String 9C2E9DA7-F794-449A-ACF6-CEE24444****

生命周期操作的标识符。

LifecycleActionStatus String Pending

生命周期操作的状态。

LifecycleActionResult String CONTINUE

该生命周期挂钩触发的生命周期操作结束后的下一步动作。取值范围:

  • CONTINUE:继续响应弹性扩张活动,将ECS实例添加至伸缩组;继续响应弹性收缩活动,将ECS实例从伸缩组移除。
  • ABANDON:终止弹性扩张活动,直接释放创建出来的ECS实例;继续响应弹性收缩活动,将ECS实例从伸缩组移除。
InstanceIds Array of String ["i-bp11m3fzlqrgk5vh****","i-bp11m3fzlqrgk5vh****"]

该生命周期挂钩挂起的ECS实例的ID。

示例

请求示例

http(s)://ess.aliyuncs.com/?Action=DescribeLifecycleActions
&ScalingActivityId=asa-bp17mug9t0pegagw****
&LifecycleActionStatus=Pending
&NextToken=AAAAAcSz4VTb1Nq****
&MaxResults=10
&RegionId=cn-qingdao
&公共请求参数

正常返回示例

XML格式

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

<DescribeLifecycleActionsResponse>
    <NextToken>AAAAAcSz4VTb1Nq****</NextToken>
    <RequestId>42A742EB-FCF3-459E-9C62-E107048C17E3</RequestId>
    <TotalCount>3</TotalCount>
    <MaxResults>3</MaxResults>
    <LifecycleActions>
        <LifecycleHookId>ash-bp18uoft0deax0f7****</LifecycleHookId>
        <LifecycleActionToken>9C2E9DA7-F794-449A-ACF6-CEE24444F7BB</LifecycleActionToken>
        <LifecycleActionStatus>Pending</LifecycleActionStatus>
        <LifecycleActionResult>CONTINUE</LifecycleActionResult>
        <InstanceIds>["i-bp11m3fzlqrgk5vh****","i-bp11m3fzlqrgk5vh****"]</InstanceIds>
    </LifecycleActions>
</DescribeLifecycleActionsResponse>

JSON格式

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

{
  "NextToken" : "AAAAAcSz4VTb1Nq****",
  "RequestId" : "42A742EB-FCF3-459E-9C62-E107048C17E3",
  "TotalCount" : 3,
  "MaxResults" : 3,
  "LifecycleActions" : [ {
    "LifecycleHookId" : "ash-bp18uoft0deax0f7****",
    "LifecycleActionToken" : "9C2E9DA7-F794-449A-ACF6-CEE24444F7BB",
    "LifecycleActionStatus" : "Pending",
    "LifecycleActionResult" : "CONTINUE",
    "InstanceIds" : [ "[\"i-bp11m3fzlqrgk5vh****\",\"i-bp11m3fzlqrgk5vh****\"]" ]
  } ]
}

错误码

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

HttpCode

错误码

错误信息

描述

400

InvalidParameter

The specified value of parameter "ScalingActivityId" is not valid.

指定的参数(ScalingActivityId)无效。

400

InvalidParameter

The specified value of parameter "MaxResults" is not valid.

指定的参数(MaxResults)无效。

400

InvalidParameter

The specified value of parameter "LifecycleActionStatus" is not valid.

指定的参数(LifecycleActionStatus)无效。