文档

DescribeLifecycleActions - 查看伸缩活动对应的生命周期操作详情

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

接口说明

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

  • Pending:挂起中。表示 ECS 实例仍处于挂起中状态。

  • Timeout:已超时。表示已超过生命周期挂钩的超时时间,自动结束了 ECS 实例的挂起中状态。

  • Completed:已处理。表示您手动提前结束了 ECS 实例的挂起中状态。

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

调试

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

授权信息

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

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

请求参数

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

伸缩活动的 ID。

asa-bp17mug9t0pegagw****
LifecycleActionStatusstring

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

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

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

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

AAAAAcSz4VTb1Nq****
MaxResultsinteger

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

默认值:10。

10
RegionIdstring

伸缩组所属的地域 ID。

cn-qingdao

返回参数

名称类型描述示例值
object
NextTokenstring

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

AAAAAcSz4VTb1Nq****
RequestIdstring

请求 ID。

42A742EB-FCF3-459E-9C62-E107048C17E3
TotalCountinteger

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

3
MaxResultsinteger

单页查询的最大条目数。

3
LifecycleActionsobject []

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

LifecycleHookIdstring

生命周期挂钩的 ID。

ash-bp18uoft0deax0f7****
LifecycleActionTokenstring

生命周期操作的标识符。

9C2E9DA7-F794-449A-ACF6-CEE24444****
LifecycleActionStatusstring

生命周期操作的状态。

Pending
LifecycleActionResultstring

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

  • CONTINUE:继续响应弹性扩张活动,将 ECS 实例添加至伸缩组;继续响应弹性收缩活动,将 ECS 实例从伸缩组移除。
  • ABANDON:终止弹性扩张活动,直接释放创建出来的 ECS 实例;继续响应弹性收缩活动,将 ECS 实例从伸缩组移除。
CONTINUE
InstanceIdsarray

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

string

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

["i-bp11m3fzlqrgk5vh****","i-bp11m3fzlqrgk5vh****"]

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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