You need to enable JavaScript to run this app.
文档中心
弹性伸缩

弹性伸缩

请输入
  • 文档首页
    • 弹性伸缩API参考生命周期挂钩DescribeLifecycleHooks - 查询生命周期挂钩列表
复制全文
下载 pdf
我的收藏
生命周期挂钩
DescribeLifecycleHooks - 查询生命周期挂钩列表
复制全文
下载 pdf
我的收藏
DescribeLifecycleHooks - 查询生命周期挂钩列表
查询生命周期挂钩。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值：DescribeLifecycleHooks​
要执行的操作，取值：DescribeLifecycleHooks。​
​
Version string 必选 示例值：2020-01-01​
API的版本，取值：2020-01-01。​
​
ScalingGroupId string 必选 示例值：scg-ybmssdnnhn5pkgyd****​
伸缩组ID。您可以调用DescribeScalingGroups查询伸缩组ID。​
​
LifecycleHookIds.N string[] 可选 示例值：sgh-ybrzhc5ht08hccnm****​
生命周期挂钩ID列表。​
  • 参数 - N：表示生命周期挂钩的序号，取值：1～20。​
  • 多个生命周期挂钩ID之间用&分隔。​
​
LifecycleHookName string 可选 示例值：hook01​
生命周期挂钩名称。​
​
PageNumber integer 可选 示例值：1​
列表的页码，默认值为1。​
​
PageSize integer 可选 示例值：10​
分页查询时每页的行数，取值范围：1～50。默认值：10。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
LifecycleHooks object[] 示例值：--​
符合条件的生命周期挂钩信息。​
LifecycleHookId string 示例值：sgh-ybrzhc5ht08hccnm****​
生命周期挂钩ID。​
​
ScalingGroupId string 示例值：scg-ybmssdnnhn5pkgyd****​
伸缩组ID。​
​
LifecycleHookName string 示例值：hook01​
生命周期挂钩名称。​
​
LifecycleHookTimeout integer 示例值：30​
ECS实例保持挂起状态的时间。​
​
LifecycleHookType string 示例值：SCALE_IN​
伸缩活动的类型，发生指定类型的伸缩活动时，生命周期挂钩会被触发并挂起ECS实例。取值：​
  • SCALE_IN：弹性收缩活动。​
  • SCALE_OUT：弹性扩张活动。​
​
LifecycleHookPolicy string 示例值：CONTINUE​
实例挂起状态结束后执行的策略。取值：​
  • CONTINUE：继续执行。​
  • REJECT：中止后续操作。​
  • ROLLBACK：针对弹性收缩活动，会拒绝释放ECS实例，进行回滚；针对弹性扩张活动，效果同REJECT相同。​
说明​
执行后实例变更流程的详细介绍请参见执行流程和策略。​
​
LifecycleCommand object 示例值：--​
云助手相关命令信息。​
CommandId string 示例值：cmd-4302d02424c5c8e10281e3a31****​
云助手命令ID。​
​
Parameters string 示例值："username":"root"​
云助手命令中的自定义参数。​
​
​
​
PageNumber integer 示例值：1​
当前页数。​
​
PageSize integer 示例值：10​
当前分页的行数。​
​
TotalCount integer 示例值：20​
符合条件的生命周期挂钩总数。​
​
​
​
请求示例​
​
GET /?Action=DescribeLifecycleHooks&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1​
Host: auto-scaling.cn-beijing.volcengineapi.com​
X-Date: 20240507T112127Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20240507192156069141091045DAD848",​
"Version": "2020-01-01",​
"Service": "auto_scaling",​
"Region": "cn-beijing"​
},​
"Result": {​
"LifecycleHooks": [​
{​
"LifecycleHookId": "sgh-ybrzhc5ht08hccnm****",​
"ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",​
"LifecycleHookName": "hook01",​
"LifecycleHookTimeout": 30,​
"LifecycleHookType": "SCALE_IN",​
"LifecycleHookPolicy": "CONTINUE",​
"LifecycleCommand": {​
"CommandId": "cmd-4302d02424c5c8e10281e3a31****",​
"Parameters": "\"username\":\"root\""​
}​
}​
],​
"PageNumber": 1,​
"PageSize": 10,​
"TotalCount": 20​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter.ScalingGroupId​
The required parameter ScalingGroupId is not supplied.​
伸缩组ID不能为空。​
400​
LimitExceeded.LifecycleHookIds​
You've reached the limit on the number of LifecycleHookIds.​
已达到生命周期挂钩ID数量上限。​
404​
InvalidScalingGroupId.NotFound​
The specified ScalingGroup [%s] does not exist.​
指定的伸缩组不存在。​
500​
InternalError​
An internal error has occurred.​
内部错误，请重试。如果多次尝试失败，请提交工单。​
​
​
最近更新时间：2025.08.27 19:18:34
这个页面对您有帮助吗？
有用
有用
无用
无用