DescribeLifecycleHooks - 查询生命周期挂钩列表--弹性伸缩-火山引擎

文档中心

立即注册

导航

DescribeLifecycleHooks - 查询生命周期挂钩列表

最近更新时间：2024.05.16 10:34:05首次发布时间：2022.09.02 08:30:42

查询生命周期挂钩。

调试

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	Array of String	否	sgh-ybrzhc5ht08hccnm****	生命周期挂钩ID列表。参数 - N：表示生命周期挂钩的序号，取值：1～20。多个生命周期挂钩ID之间用&分隔。
LifecycleHookName	String	否	hook01	生命周期挂钩名称。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数，取值范围：1～50。默认值：10。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
LifecycleHooks	Array of LifecycleHook	--	符合条件的生命周期挂钩信息。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	当前分页的行数。
TotalCount	Integer	20	符合条件的生命周期挂钩总数。

请求示例

GET /?Action=DescribeLifecycleHooks&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.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
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。