华为云用户手册

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

响应示例 { "lifecycle_hook_name": "test-hook1", "default_result": "CONTINUE", "default_timeout": 3600, "notification_topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh", "notification_topic_name": "gsh", "lifecycle_hook_type": "INSTANCE_LAUNCHING", "notification_metadata": null, "create_time": "2016-11-18T04:01:34Z"}

响应参数 表3 响应参数 参数 参数类型 描述 lifecycle_hook_name String 生命周期挂钩名称 lifecycle_hook_type String 生命周期挂钩类型。 INSTANCE_TERMINATING INSTANCE_LAUNCHING default_result String 生命周期挂钩默认回调操作。 ABANDON CONTINUE default_timeout Integer 生命周期挂钩超时时间，单位秒。 notification_topic_urn String SMN 服务中Topic的唯一的资源标识。 notification_topic_name String SMN服务中Topic的资源名称。 notification_metadata String 自定义通知消息。 create_time String 创建生命周期挂钩时间，遵循UTC时间。

请求示例 修改ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组内挂钩名称为test-hook1的生命周期挂钩，将其回调操作修改为CONTINUE。 PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1{ "default_result": "CONTINUE"}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

URI PUT /autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/{scaling_group_id}/{lifecycle_hook_name} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID lifecycle_hook_name 是 String 生命周期挂钩名称

伸缩活动日志 权限 对应API接口 授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 查询伸缩活动日志 GET /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id} as:acivityLogs:list √ √ 查询伸缩活动日志V2版本 GET /autoscaling-api/v2/{project_id}/scaling_activity_log/{scaling_group_id} as:acivityLogs:list √ √ 父主题： 权限和授权项

响应参数 表5 响应参数 参数 参数类型 描述 resources Array of Resource objects 标签资源实例，详情请见表6。 total_count Integer 总记录数，当请求action为count时，仅返回该参数，不返回resources和marker值。 marker String 分页位置标识 表6 Resource字段说明 参数 参数类型 描述 resource_id String 资源详情ID resource_detail String 资源详情 tags Array of ResourceTag objects 标签列表，没有标签默认为空数组，详情请见表7。 resource_name String 资源名称，没有资源时默认为空字符串。 表7 ResourceTag字段说明 参数 参数类型 描述 key String 资源标签键。最大长度36个unicode字符。 value String 资源标签值。最大长度43个unicode字符。

响应示例 action为filter时响应示例 {"resources": [{"resource_id": "64af4b6f-ec51-4436-8004-7a8f30080c87","resource_detail": "SCALING_GROUP_TAG","tags": [{"key": "key1","value": "value1"}],"resource_name": "as_scaling_group_1"},{"resource_id": "7122ef51-604b-40e7-b9b2-1de4cd78dc60","resource_detail": "SCALING_GROUP_TAG","tags": [{"key": "key1","value": "value1"}],"resource_name": "as_scaling_group_2"}],"marker": "2","total_count": 2} action为count时响应示例 { "total_count": 1000}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 tags 否 Array of Tag objects 过滤条件，包含标签，最多包含10个Key，结构体不能缺失，详情请见表 Tag字段数据结构说明。 tags_any 否 Array of Tag objects 过滤条件，包含任意标签，最多包含10个Key，详情请见表 Tag字段数据结构说明。 not_tags 否 Array of Tag objects 过滤条件，不包含标签，最多包含10个Key，详情请见表 Tag字段数据结构说明。 not_tags_any 否 Array of Tag objects 过滤条件，不包含任意标签，最多包含10个Key，详情请见表 Tag字段数据结构说明。 limit 否 String 查询记录数，最大值为1000，不能为负数，最小值为1。 如果action的值为count，此参数无效。 如果action的值为filter，limit默认为1000。 marker 否 String 分页位置标识（索引位置）。推荐使用offset字段设置索引位置。 分页位置标识(资源ID或索引位置)。 action 是 String 操作标识，包括filter和count两种。 filter（过滤）：表示按标签过滤资源，返回符合条件的资源列表。此时，为分页查询。 count（查询总条数）：表示按标签搜索资源，返回符合条件的资源个数。 offset 否 String 索引位置，从offset指定的下一条数据开始查询。必须为数字，不能为负数。 查询第一页数据时，不需要传入此参数。查询后续页码数据时，将查询前一页数据时响应体中的offset值带入此参数。 如果action的值为count，此参数无效。 如果action的值为filter，offset默认为0。 matches 否 Array of match objects 模糊搜索字段，详情请见表 match字段数据结构说明。 表3 Tag字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 资源标签键。最大长度36个unicode字符。key不能为空。（搜索时不对此参数做校验）。最多为10个，不能为空或者空字符串。且不能重复。 values 是 Array of strings 资源标签值列表，每个值最大长度43个unicode字符，每个key下最多为10个，同一个key中values不能重复。 “*”为系统保留字符，如果value是以“*”开头表示按照“*”后面的值全模糊匹配。不能只传入“*”。 如果values为空列表但不可缺省，则表示any_value（查询任意value）。value之间为或的关系。 表4 match字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键，表示要匹配的字段。 当前key的参数值只能取“resource_name”。 value 是 String 值。为固定字典值。每个值最大长度255个unicode字符。若为空字符串、resource_id时为精确匹配。

请求示例 查询租户下按包含标签key=key1，value=value1，不包含key=key2，value=value2，索引位置100，查询最大记录数为100的伸缩组资源信息，action为filter。 POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action{"offset": "100","limit": "100","action": "filter","matches": [{"key": "resource_name","value": "resource1"}],"not_tags": [{"key": "key2","values": ["value2"]}],"tags": [{"key": "key1","values": ["value1"]}]} 查询租户下按包含标签key=key1，value=value1，不包含key=key2，value=value2的伸缩组资源数目，action为count。 POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action{"action": "count","not_tags": [{"key": "key2","values": ["value2"]}],"tags": [{"key": "key1","values": ["value1"]}],"matches": [{"key": "resource_name","value": "resource1"}]}

请求示例 查询在ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组内，ID为b25c1589-c96c-465b-9fef-d06540d1945c的实例的挂起信息。 GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_instance_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?instance_id=b25c1589-c96c-465b-9fef-d06540d1945c

响应示例 { "instance_hanging_info": [ { "instance_id": "b25c1589-c96c-465b-9fef-d06540d1945c", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "lifecycle_hook_name": "hook-test", "lifecycle_action_key": "6ebe6e72-4b09-4adb-ae4a-a91dc0560069", "default_result": "ABANDON", "timeout": "2016-11-15T06:43:41Z", "lifecycle_hook_status": "HANGING" } ]}

URI GET /autoscaling-api/v1/{project_id}/scaling_instance_hook/{scaling_group_id}/list 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤，请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_group_id 是 String 伸缩组ID。 instance_id 否 String 伸缩实例ID。

响应参数 表2 响应参数 参数 参数类型 描述 instance_hanging_info Array of instance_hanging_info objects 伸缩实例生命周期挂钩列表。 表3 instance_hanging_info字段数据结构说明 参数 参数类型 描述 lifecycle_hook_name String 生命周期挂钩名称。 lifecycle_action_key String 生命周期操作令牌，用于指定生命周期回调对象。 instance_id String 伸缩实例ID。 scaling_group_id String 伸缩组ID。 lifecycle_hook_status String 伸缩实例挂钩的挂起状态。 HANGING：挂起 CONTINUE：继续 ABANDON：终止 timeout String 超时时间，遵循UTC时间，格式为：YYYY-MM-DDThh:mm:ssZ default_result String 生命周期挂钩默认回调操作。

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

支持的授权项 细粒度策略支持的操作与API相对应，授权项列表说明如下： 权限：自定义策略中授权项定义的内容即为权限。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目，“√”表示支持，“×”表示暂不支持。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 AS支持自定义策略授权项如下所示： 弹性伸缩组，包含伸缩组接口对应的授权项，如创建伸缩组、修改伸缩组、查询伸缩组等接口。 弹性伸缩配置，包含伸缩配置接口对应的授权项，如创建伸缩配置、删除伸缩配置、查询伸缩配置等接口。 弹性伸缩实例，包含伸缩实例接口对应的授权项，如查询弹性伸缩组中的实例列表、移出弹性伸缩组实例等接口。 弹性伸缩策略，包含弹性伸缩策略接口对应的授权项，如创建弹性伸缩策略、修改弹性伸缩策略等接口。 伸缩策略执行日志，包含查询策略执行日志接口对应的授权项。 伸缩活动日志，包含查询伸缩活动日志接口对应的授权项。 配额，包含弹性伸缩配额接口对应的授权项，如查询弹性伸缩配额等接口。 通知，包含弹性伸缩通知接口对应的授权项，如查询伸缩组通知列表等接口。 生命周期挂钩，包含生命周期挂钩相关接口的授权项，如创建生命周期挂钩等接口。 标签管理，包含弹性伸缩标签接口对应的授权项，如查询标签等接口。

响应示例 { "lifecycle_hook_name": "test-hook1", "default_result": "ABANDON", "default_timeout": 3600, "notification_topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh", "notification_topic_name": "gsh", "lifecycle_hook_type": "INSTANCE_LAUNCHING", "notification_metadata": null, "create_time": "2019-03-18T16:00:11Z"}

响应参数 表3 响应参数 参数 参数类型 描述 lifecycle_hook_name String 生命周期挂钩名称 lifecycle_hook_type String 生命周期挂钩类型。 INSTANCE_TERMINATING INSTANCE_LAUNCHING default_result String 生命周期挂钩默认回调操作。 ABANDON CONTINUE default_timeout Integer 生命周期挂钩超时时间，单位秒。 notification_topic_urn String SMN 服务中 Topic 的唯一的资源标识。 notification_topic_name String SMN 服务中 Topic 的资源名称。 notification_metadata String 自定义通知消息 create_time String 生命周期挂钩创建时间，遵循UTC时间。

请求示例 创建一个名称为test-hook1的生命周期挂钩，伸缩组ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a，回调操作为ABANDON，超时时间为3600秒， 消息通知 topic_urn为urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh，挂钩类型为在实例启动时挂起实例。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a{ "lifecycle_hook_name": "test-hook1", "default_result": "ABANDON", "default_timeout": 3600, "notification_topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh", "lifecycle_hook_type": "INSTANCE_LAUNCHING"}

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。

请求示例 修改计划任务0h327883-324n-4dzd-9c61-68d03ee191dd，修改为每天17:00 将伸缩组的最大实例数设置为10，最小实例数设置为5。 PUT https://{Endpoint}/v1/{project_id}/scaling-groups/xxxxxx/scheduled-tasks/0h327883-324n-4dzd-9c61-68d03ee191dd{ "name": "task_01", "scheduled_policy": { "start_time": "2016-01-08T17:31Z", "end_time": "2016-02-08T17:31Z", "launch_time": "17:00", "recurrence_type": "Daily" }, "instance_number": { "max": 10, "min": 5 }}

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 name 否 String 计划任务名称 scheduled_policy 否 Object 计划任务策略，请参考表3 instance_number 否 Object 伸缩组实例数，请参考表4 表3 scheduled_policy字段数据结构说明 参数 是否必选 参数类型 描述 start_time 否 String 计划任务的生效开始时间。仅当recurrence_type不为空时生效，格式为yyyy-MM-dd'T'HH:mm'Z'，不填写时默认为任务创建成功的时间。 end_time 否 String 计划任务的生效结束时间。仅当recurrence_type不为空时生效且必选，格式为yyyy-MM-dd'T'HH:mm'Z'。 launch_time 是 String 计划任务的执行时间。采用UTC时间，当recurrence_type不填写或为空时,格式为yyyy-MM-dd'T'HH:mm'Z'，当recurrence_type不为空时，格式为HH:mm。 recurrence_type 否 String 不填写或为空时计划任务为定时执行，填写时计划任务为周期执行，且只能填写DAILY、WEEKLY、MONTHLY 中的一种，分别为按天、按周、按月周期执行。 recurrence_value 否 String 仅当recurrence_type为WEEKLY、MONTHLY时必选，表示周期执行的具体日期，多个日期用,分割，当recurrence_type为WEEKLY时，可填入1-7，当recurrence_type为MONTHLY时，可填入1-31。 表4 instance_number字段数据结构说明 参数 是否必选 参数类型 描述 max 否 Integer 伸缩组最大实例数 min 否 Integer 伸缩组最小实例数 desire 否 Integer 伸缩组期望实例数

返回值 正常 204 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成，服务异常。 501 Not Implemented 请求未完成，服务器不支持所请求的功能。 502 Bad Gateway 请求未完成，服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成，系统暂时异常。 504 Gateway Timeout 网关超时。

URI PUT /autoscaling-api/v1/{project_id}/scaling-groups/{scaling_group_id}/scheduled-tasks/{scheduled_task_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID scheduled_task_id 是 String 计划任务ID

响应参数 表2 响应参数 参数 参数类型 描述 lifecycle_hook_name String 生命周期挂钩名称。 lifecycle_hook_type String 生命周期挂钩类型。 INSTANCE_TERMINATING INSTANCE_LAUNCHING default_result String 生命周期挂钩默认回调操作。 ABANDON CONTINUE default_timeout Integer 生命周期挂钩超时时间，单位秒。 notification_topic_urn String SMN服务中Topic的唯一的资源标识。 notification_topic_name String SMN服务中Topic的资源名称。 notification_metadata String 自定义通知消息。 create_time String 创建生命周期挂钩时间，遵循UTC时间。

响应示例 { "lifecycle_hook_name": "test-hook1", "default_result": "CONTINUE", "default_timeout": 3600, "notification_topic_urn": "urn:smn:regionId:b53e5554fad0494d96206fb84296510b:gsh", "notification_topic_name": "gsh", "lifecycle_hook_type": "INSTANCE_LAUNCHING", "notification_metadata": null, "create_time": "2016-11-18T04:01:34Z"}

请求示例 查询ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组内挂钩名称为test-hook1的生命周期挂钩详情。 GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_lifecycle_hook/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/test-hook1

返回值 正常 200 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求的页面访问禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。