调用DescribeLifecycleHooks通过指定生命周期挂钩ID或伸缩组ID来查询生命周期挂钩的信息,包括等待状态结束后的下一步动作、生命周期挂钩对应的伸缩活动类型、通知对象标识符、挂起等待时间等。
接口说明
您可以通过以下三种方式查询生命周期挂钩:
-
指定一个生命周期挂钩 ID 列表(LifecycleHookIds),此时将忽略伸缩组 ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)参数。
-
指定伸缩组 ID(ScalingGroupId)。
-
同时指定伸缩组 ID(ScalingGroupId)和生命周期挂钩名称(LifecycleHookName)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ess:DescribeLifecycleHooks |
get |
*ScalingGroup
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ScalingGroupId |
string |
否 |
伸缩组的 ID。 |
asg-bp1igpak5ft1flyp**** |
| LifecycleHookName |
string |
否 |
生命周期挂钩名称。 |
lifecyclehook**** |
| PageNumber |
integer |
否 |
实例状态列表的页码,起始值:1。 默认值:1。 |
1 |
| PageSize |
integer |
否 |
分页查询时设置的每页行数,最大值:50。 默认值:50。 |
50 |
| LifecycleHookIds |
array |
否 |
生命周期挂钩的 ID 列表。 |
|
|
string |
否 |
生命周期挂钩的 ID。 |
ash-bp1at9ufhmcf9cmy**** |
|
| RegionId |
string |
否 |
伸缩组所属地域的 ID。 |
cn-beijing |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
查询生命周期挂钩返回信息。 |
||
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
查询起始页数。 |
1 |
| PageSize |
integer |
查询每页返回行数。 |
50 |
| TotalCount |
integer |
生命周期挂钩总个数。 |
1 |
| LifecycleHooks |
array<object> |
生命周期挂钩信息列表。 |
|
|
object |
生命周期挂钩的信息。 |
||
| DefaultResult |
string |
实例挂起等待状态结束后的下一步动作。 |
CONTINUE |
| LifecycleHookId |
string |
生命周期挂钩 ID。 |
ash-bp19d1032y9kij96**** |
| LifecycleHookName |
string |
生命周期挂钩的名称。 |
lifecyclehook**** |
| LifecycleTransition |
string |
生命周期挂钩对应的伸缩活动类型。 |
SCALE_OUT |
| NotificationMetadata |
string |
伸缩活动的等待状态的固定字符串信息。 |
Test Lifecycle Hook. |
| NotificationArn |
string |
生命周期挂钩通知对象标识符,参数格式如下:
参数格式中的变量含义如下:
|
acs:ess:cn-beijing:161456884340****:null/null |
| HeartbeatTimeout |
integer |
生命周期挂钩为伸缩活动设置的等待时间,等待超时后会执行下一步动作。 |
60 |
| ScalingGroupId |
string |
伸缩组 ID。 |
asg-bp1igpak5ft1flyp**** |
| LifecycleHookStatus |
string |
生命周期挂钩的状态,可能值:
|
Active |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"PageSize": 50,
"TotalCount": 1,
"LifecycleHooks": [
{
"DefaultResult": "CONTINUE",
"LifecycleHookId": "ash-bp19d1032y9kij96****",
"LifecycleHookName": "lifecyclehook****",
"LifecycleTransition": "SCALE_OUT",
"NotificationMetadata": "Test Lifecycle Hook.",
"NotificationArn": "acs:ess:cn-beijing:161456884340****:null/null",
"HeartbeatTimeout": 60,
"ScalingGroupId": "asg-bp1igpak5ft1flyp****",
"LifecycleHookStatus": "Active"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。