You need to enable JavaScript to run this app.
导航

DescribeLifecycleHooks

最近更新时间2023.10.07 11:10:51

首次发布时间2022.09.02 08:30:42

调用 DescribeLifecycleHooks 查询生命周期挂钩。

输入参数

名称类型是否必选示例值描述
ActionStringDescribeLifecycleHooks要执行的操作,取值:DescribeLifecycleHooks。
VersionString2020-01-01API的版本,取值为:2020-01-01。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。

LifecycleHookIds.N

String

LifecycleHookIds.1=sgh-ybrzhc5ht08hccnm****&LifecycleHookIds.2=sgh-ybrzhc5ht08hccmn****

生命周期挂钩ID。

  • 参数 - N:表示生命周期挂钩的序号,取值:1~20。

  • 多个生命周期挂钩ID之间用&分隔。

LifecycleHookNameStringhook01生命周期挂钩名称。
PageNumberInteger1列表的页码,默认值为1。
PageSizeInteger10分页查询时每页的行数,取值范围:1~50。默认值:10。

返回数据

名称类型示例值描述
LifecycleHooksArray of struct-符合条件的生命周期挂钩信息。具体请参见下表“LifecycleHook结构”。
TotalCountInteger20符合条件的生命周期挂钩总数。
PageNumberInteger1当前页数。
PageSizeInteger10当前分页的行数。

LifecycleHook 结构

名称类型示例值描述
LifecycleHookIdStringsgh-ybrzhc5ht08hccnm****生命周期挂钩ID。
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组ID。
LifecycleHookNameStringhook01生命周期挂钩名称。
LifecycleHookTimeoutInteger30ECS实例保持挂起状态的时间。

LifecycleHookType

String

SCALE_IN

伸缩活动的类型,发生指定类型的伸缩活动时,生命周期挂钩会被触发并挂起ECS实例。
取值:

  • SCALE_IN:弹性收缩活动。
  • SCALE_OUT:弹性扩张活动。

LifecycleHookPolicy

String

CONTINUE

实例挂起状态结束后执行的策略。取值:

  • CONTINUE:继续执行。
  • REJECT:中止后续操作。
  • ROLLBACK:针对弹性收缩活动,会拒绝释放ECS实例,进行回滚;针对弹性扩张活动,效果同REJECT相同。
    执行后实例变更流程的详细介绍请参见执行流程和策略
LifecycleCommandStruct-批量作业相关命令信息,详见下面"LifecycleCommand结构体"。

LifecycleCommand 结构

名字类型示例值描述
CommandIdStringcmd-4302d02424c5c8e10281e3a31****批量作业命令ID。
ParametersString{"username":"root","password":"123456"}批量作业命令中的自定义参数。

请求示例

GET /?Action=DescribeLifecycleHooks&ScalingGroupId=scg-ybq*****6t&LifecycleHookIds.1=sgh-ybrzg7******927&PageNumber=1&PageSize=10&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220630103407010174235038035F****",
        "Action": "DescribeLifecycleHooks",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "LifecycleHooks": [
            {
                "LifecycleHookId": "sgh-ybrzhc5ht08hccnm****",
                "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",
                "LifecycleHookName": "hooks01",
                "LifecycleHookTimeout": 30,
                "LifecycleHookType": "SCALE_OUT",
                "LifecycleHookPolicy": "CONTINUE",
                "LifecycleCommand":{}
            }
        ],
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10
    }
}