华为云用户手册

响应示例 { "scaling_group": { "networks": [ { "id": " a8327883-6b07-4497-9c61-68d03ee193a ", "ipv6_enable": true, "ipv6_bandwidth": { "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5" } } ], "available_zones": [ "XXXa", "XXXb" ], "detail": null, "scaling_group_name": "api_gateway_modify", "scaling_group_id": "d4e50321-3777-4135-97f8-9f5e9714a4b0", "scaling_group_status": "INSERVICE", "scaling_configuration_id": "53579851-3841-418d-a97b-9cecdb663a90", "scaling_configuration_name": "press", "current_instance_number": 7, "desire_instance_number": 8, "min_instance_number": 0, "max_instance_number": 100, "cool_down_time": 900, "lb_listener_id": null, "security_groups": [ { "id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab" } ], "create_time": "2015-09-01T08:36:10Z", "vpc_id": "3e22f934-800d-4bb4-a588-0b9a76108190", "health_periodic_audit_method": "NOVA_AUDIT", "health_periodic_audit_time": 5, "health_periodic_audit_grace_period": 600, "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE", "is_scaling": true, "delete_publicip": false, "notifications": null, "enterprise_project_id":"c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "activity_type":"MODIFY_ELB", "multi_az_priority_policy":"PICK_FIRST", "iam_agency_name":"test", "tags":[{"key":"1"}] }}

返回值 正常 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 响应参数 参数 参数类型 描述 scaling_group scaling_groups object 伸缩组详情。 表3 scaling_groups字段数据结构说明 参数 参数类型 描述 scaling_group_name String 伸缩组名称。 scaling_group_id String 伸缩组ID。 scaling_group_status String 伸缩组状态。 scaling_configuration_id String 伸缩配置ID。 scaling_configuration_name String 伸缩配置名称。 current_instance_number Integer 伸缩组中当前实例数。 desire_instance_number Integer 伸缩组中期望实例数。 min_instance_number Integer 伸缩组中最小实例数。 max_instance_number Integer 伸缩组中最大实例数。 cool_down_time Integer 冷却时间，单位是秒。 lb_listener_id String 经典型负载均衡监听器ID，多个负载均衡监听器ID以逗号分隔。 lbaas_listeners Array of lbaas_listeners objects 增强型负载均衡器信息，详情请见表 lbaas_listeners字段数据结构说明。 available_zones Array of strings 可用区信息。 networks Array of networks objects 网络信息，详情请见表5 security_groups Array of security_groups objects 安全组信息，详情请见表8 create_time String 创建伸缩组时间，遵循UTC时间。 vpc_id String 伸缩组所在的VPC ID。 detail String 伸缩组详情。当伸缩活动失败时，在此处记录错误信息。 is_scaling Boolean 伸缩组伸缩标志。 health_periodic_audit_method String 健康检查方式。 health_periodic_audit_time Integer 健康检查的间隔时间。 health_periodic_audit_grace_period Integer 健康状况检查宽限期。 instance_terminate_policy String 移除策略。 notifications Array of strings 通知方式： EMAIL为发送邮件通知。 该通知方式已经被废除，建议给弹性伸缩组配置通知功能。请参考通知。 delete_publicip Boolean 删除云服务器是否删除云服务器绑定的弹性IP。 delete_volume Boolean 删除云服务器是否删除云服务器绑定的数据盘。 cloud_location_id String 该参数为预留字段。 enterprise_project_id String 企业项目ID activity_type String 伸缩组活动类型。 multi_az_priority_policy String 伸缩组扩缩容时目标AZ选择的优先级策略。 description String 伸缩组描述。 iam_agency_name String 委托。 tags Array of tags objects 添加到伸缩组的标签。详情请见表9 表4 networks字段数据结构说明 参数 参数类型 描述 id String 子网的网络ID。 ipv6_enable Boolean 是否启用IPv6。取值为true时，标识此网卡已启用ipv6。默认取值为false。 ipv6_bandwidth ipv6_bandwidth object 绑定的IPv6共享带宽，默认为空，表示不绑定IPv6的共享带宽。 allowed_address_pairs Array of allowed_address_pairs objects 是否开启源/目的检查开关。 表5 ipv6_bandwidth字段数据结构说明 参数 参数类型 描述 id String IPv6共享带宽的ID。 表6 allowed_address_pairs字段数据结构说明 参数 参数类型 描述 ip_address String 是否开启源/目的检查开关。 默认是开启，不允许置空。 关闭：1.1.1.1/0 开启：除“1.1.1.1/0”以外的其余值均按开启处理

请求示例 启用ID为a8327883-6b07-4497-9c61-68d03ee193a1的伸缩组。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action{ "action": "resume"} 停止ID为a8327883-6b07-4497-9c61-68d03ee193a1的伸缩组。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action{ "action": "pause"}

返回值 正常 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 网关超时。

返回值 正常 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 网关超时。

请求示例 修改ID为a8327883-6b07-4497-9c61-68d03ee193a1的伸缩组，修改其名称、伸缩配置、企业项目、期望实例数、最小实例数、最大实例数和冷却时间等参数。 PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1{ "scaling_group_name": "group_1", "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2", "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "desire_instance_number": 1, "min_instance_number": 1, "max_instance_number": 3, "cool_down_time": 200, "multi_az_priority_policy": "PICK_FIRST", "iam_agency_name":"test"}

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_group_name 否 String 伸缩组名称(1-64个字符)，只能包含中文、字母、数字、下划线或中划线。 desire_instance_number 否 Integer 期望实例数量。 最小实例数≤期望实例数≤最大实例数。 min_instance_number 否 Integer 最小实例数量。 max_instance_number 否 Integer 最大实例数量，大于等于最小实例数。 cool_down_time 否 Integer 冷却时间，取值范围0-86400，默认为300，单位是秒。 available_zones 否 Array of strings 可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区，会由系统自动指定可用区。 详情请参考地区和终端节点。 仅当伸缩组中无伸缩活动时，才可以修改可用区配置。 networks 否 Array of networks objects 网络信息，最多支持选择5个子网，传入的第一个子网默认作为云服务器的主网卡。获取子网信息请参考查询子网列表。数据结构信息请参考表4。 仅当同时满足以下条件时，才可以修改： 伸缩组中无伸缩活动 实例数为0 伸缩组为非启用状态 security_groups 否 Array of security_groups objects 安全组信息，仅支持选择1个安全组。获取安全组信息请参考查询安全组列表。数据结构信息请参考表7。 当伸缩配置和伸缩组同时指定安全组时，将以伸缩配置中的安全组为准；当伸缩配置和伸缩组都没有指定安全组时，增加的弹性云服务器将使用默认安全组。为了使用灵活性更高，推荐在伸缩配置中指定安全组。仅当同时满足以下条件时，才可以修改： 伸缩组中无伸缩活动 实例数为0 伸缩组为非启用状态 lb_listener_id 否 String 弹性负载均衡监听器ID，最多支持绑定6个负载均衡监听器，多个负载均衡监听器ID以逗号分隔。获取监听器ID的方法请参考查询负载均衡器列表。 仅当同时满足以下条件时，才可以修改： 伸缩组中无伸缩活动 lbaas_listeners 否 Array of lbaas_listeners objects 弹性负载均衡器信息，最多支持绑定6个负载均衡。列表数据结构请参考表3。获取负载均衡器的信息请参考查询后端云服务器组。 health_periodic_audit_method 否 String 伸缩组实例健康检查方式：ELB_AUDIT和NOVA_AUDIT。当伸缩组设置负载均衡时，默认为ELB_AUDIT；否则默认为NOVA_AUDIT。 ELB_AUDIT：负载均衡健康检查方式，在有监听器的伸缩组中有效。 NOVA_AUDIT：云服务器健康检查方式，是弹性伸缩自带的健康检查方式。 health_periodic_audit_time 否 Integer 伸缩组实例健康检查周期（分钟）：1、5、15、60、180。 若设置为0，可以实现10秒级健康检查。 instance_terminate_policy 否 String 伸缩组实例移除策略： OLD_CONFIG_OLD_INSTANCE（默认）：从“较早创建的配置”创建的实例中选择较早创建的实例进行优先移除。 OLD_CONFIG_NEW_INSTANCE：从“较早创建的配置”创建的实例中选择较晚创建的实例进行优先移除。 OLD_INSTANCE：较早创建的实例被优先移除。 NEW_INSTANCE：较晚创建的实例将被优先移除。 health_periodic_audit_grace_period 否 Integer 伸缩组实例健康状况检查宽限期，取值范围0-86400，单位是秒，默认为600。 当实例加入伸缩组并且进入已启用状态后，健康状况检查宽限期才会启动，伸缩组会等健康状况检查宽限期结束后才检查实例的运行状况。 当伸缩组实例健康检查方式为ELB_AUDIT时，该参数生效。 scaling_configuration_id 否 String 伸缩配置ID，通过查询弹性伸缩配置列表接口获取，请参考查询弹性伸缩配置列表。 notifications 否 Array of strings 通知方式： EMAIL为发送邮件通知。 该通知方式已经被废除，建议给弹性伸缩组配置通知功能。请参考通知。 delete_publicip 否 Boolean 配置删除云服务器是否删除云服务器绑定的弹性IP。如果选择不删除，则系统仅做解绑定操作，保留弹性IP资源。 true：删除云服务器时会同时删除绑定在云服务器上的弹性IP。当弹性IP的计费方式为包年包月时，不会被删除。 false：删除云服务器时，仅解绑定在云服务器上的弹性IP，不删除弹性IP。 delete_volume 否 Boolean 配置删除云服务器时是否删除云服务器绑定的数据盘。取值为true或false，默认为false。 true：删除云服务器时，会同时删除绑定在云服务器上的数据盘。当数据盘的计费方式为包年包月时，不会被删除。 false：删除云服务器时，仅解绑定在云服务器上的数据盘，不删除数据盘。 enterprise_project_id 否 String 企业项目ID，用于指定伸缩组归属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为UUID，表示属于该UUID对应的企业项目，如何获取企业项目ID，请参考查询企业项目列表。 当伸缩组配置企业项目时，由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。 说明： 关于企业项目特性的详细信息，请参见企业项目管理。 multi_az_priority_policy 否 String 伸缩组扩缩容时目标AZ选择的优先级策略： EQUILIBRIUM_DISTRIBUTE（默认）：均衡分布，虚拟机扩缩容时优先保证available_zones列表中各AZ下虚拟机数量均衡，当无法在目标AZ下完成虚拟机扩容时，按照PICK_FIRST原则选择其他可用AZ。 PICK_FIRST：选择优先，虚拟机扩缩容时目标AZ的选择按照available_zones列表的顺序进行优先级排序。 description 否 String 伸缩组描述（1-256个字符）。 iam_agency_name 否 String 委托（1-64个字符）。 iam_agency_name为无值则无需修改。 iam_agency_name为空字符串或者其他字符串，则需修改。 表3 lbaas_listeners字段数据结构说明 参数 是否必选 参数类型 描述 pool_id 是 String 后端云服务器组ID。 仅当同时满足以下条件时，才可以修改： 伸缩组中无伸缩活动 protocol_port 是 Integer 后端协议号，指后端云服务器监听的端口，取值范围[1, 65535]。 weight 是 Integer 权重，指后端云服务器经分发得到的请求数量的比例，取值范围[0, 100]。 protocol_version 否 String 绑定到负载均衡云服务器组的IP地址版本，枚举值支持ipv4和ipv6。 说明： 伸缩组实例不支持多网卡双栈，仅支持首网卡双栈，其他网卡地址会被忽略。首网卡是指从弹性云服务器查询到的第一张支持所选IP地址版本的网卡，可能是主网卡，也可能是扩展网卡。 只有选择支持IPv6的弹性云服务器，才可以使用IPv4/IPv6双栈网络，请务必选择支持的区域和规格。 当pool_id、protocol_port、protocol_version均一致时，会进行去重。 表4 networks字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 子网的网络ID。 ipv6_enable 否 Boolean 是否启用IPv6。 true：标识此网卡已启用ipv6。 false：标识此网卡未启用ipv6。默认取值为false。 ipv6_bandwidth 否 ipv6_bandwidth object 绑定的IPv6共享带宽。默认为空，表示未绑定IPv6的共享带宽。 allowed_address_pairs 否 Array of allowed_address_pairs objects 是否开启源/目的检查开关。 表5 ipv6_bandwidth字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String IPv6共享带宽的ID 表6 allowed_address_pairs字段数据结构说明 参数 参数类型 描述 ip_address String 是否开启源/目的检查开关。 默认是开启，不允许置空。 关闭：1.1.1.1/0 开启：除“1.1.1.1/0”以外的其余值均按开启处理 表7 security_groups字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 安全组ID。

响应示例 { "limit": 20, "scaling_groups": [ { "networks": [ { "id": "a8327883-6b07-4497-9c61-68d03ee193a", "ipv6_enable": true, "ipv6_bandwidth": { "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5" } } ], "available_zones": [ "XXXa", "XXXb" ], "detail": null, "scaling_group_name": "as-group-test", "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e2709150", "scaling_group_status": "INSERVICE", "scaling_configuration_id": "1d281494-6085-4579-b817-c1f813be835f", "scaling_configuration_name": "healthCheck", "current_instance_number": 0, "desire_instance_number": 1, "min_instance_number": 0, "max_instance_number": 500, "cool_down_time": 300, "lb_listener_id": "f06c0112570743b51c0e8fbe1f235bab", "security_groups": [ { "id": "8a4b1d5b-0054-419f-84b1-5c8a59ebc829" } ], "create_time": "2015-07-23T02:46:29Z", "vpc_id": "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2", "health_periodic_audit_method": "ELB_AUDIT", "health_periodic_audit_time": 5, "health_periodic_audit_grace_period": 600, "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE", "is_scaling": false, "delete_publicip": false, "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "multi_az_priority_policy": "PICK_FIRST", "iam_agency_name":"test" } ], "total_number": 1, "start_number": 0}

返回值 正常 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 响应参数 参数 参数类型 描述 total_number Integer 总记录数。 start_number Integer 查询的开始记录号。 limit Integer 查询记录数。 scaling_groups Array of scaling_groups objects 伸缩组列表。 表3 scaling_groups字段数据结构说明 参数 参数类型 描述 scaling_group_name String 伸缩组名称。 scaling_group_id String 伸缩组ID。 scaling_group_status String 伸缩组状态。 scaling_configuration_id String 伸缩配置ID。 scaling_configuration_name String 伸缩配置名称。 current_instance_number Integer 伸缩组中当前实例数。 desire_instance_number Integer 伸缩组中期望实例数。 min_instance_number Integer 伸缩组中最小实例数。 max_instance_number Integer 伸缩组中最大实例数。 cool_down_time Integer 冷却时间，单位是秒。 lb_listener_id String 经典型负载均衡监听器ID，多个负载均衡监听器ID以逗号分隔。 lbaas_listeners Array of lbaas_listeners objects 增强型负载均衡器信息，详情请见表 lbaas_listeners字段数据结构说明。 available_zones Array of strings 可用区信息。 networks Array of networks objects 网络信息，详情请见表5 security_groups Array of security_groups objects 安全组信息，详情请见表8 create_time String 创建伸缩组时间，遵循UTC时间。 vpc_id String 伸缩组所在的VPC ID。 detail String 伸缩组详情。当伸缩活动失败时，在此处记录错误信息。 is_scaling Boolean 伸缩组伸缩标志。 health_periodic_audit_method String 健康检查方式。 health_periodic_audit_time Integer 健康检查的间隔时间。 health_periodic_audit_grace_period Integer 健康状况检查宽限期。 instance_terminate_policy String 移除策略。 notifications Array of strings 通知方式： EMAIL为发送邮件通知。 该通知方式已经被废除，建议给弹性伸缩组配置通知功能。请参考通知。 delete_publicip Boolean 删除云服务器是否删除云服务器绑定的弹性IP。 delete_volume Boolean 删除云服务器是否删除云服务器绑定的数据盘。 cloud_location_id String 该参数为预留字段。 enterprise_project_id String 企业项目ID activity_type String 伸缩组活动类型。 multi_az_priority_policy String 伸缩组扩缩容时目标AZ选择的优先级策略。 description String 伸缩组描述。 iam_agency_name String 委托。 tags Array of tags objects 添加到伸缩组的标签。详情请见表9 表4 lbaas_listeners字段数据结构说明 参数 参数类型 描述 listener_id String 监听器ID pool_id String 后端云服务器组ID protocol_port Integer 后端协议号，指后端云服务器监听的端口。 weight Integer 权重，指后端云服务器经分发得到的请求数量的比例。 protocol_version String 绑定到负载均衡云服务器组的IP地址版本，枚举值为ipv4和ipv6。 表5 networks字段数据结构说明 参数 参数类型 描述 id String 子网的网络ID。 ipv6_enable Boolean 是否启用IPv6。取值为true时，标识此网卡已启用ipv6。默认取值为false。 ipv6_bandwidth ipv6_bandwidth object 绑定的IPv6共享带宽，默认为空，表示不绑定IPv6的共享带宽。 allowed_address_pairs Array of allowed_address_pairs objects 是否开启源/目的检查开关。 表6 ipv6_bandwidth字段数据结构说明 参数 参数类型 描述 id String IPv6共享带宽的ID。 表7 allowed_address_pairs字段数据结构说明 参数 参数类型 描述 ip_address String 是否开启源/目的检查开关。 默认是开启，不允许置空。 关闭：1.1.1.1/0 开启：除“1.1.1.1/0”以外的其余值均按开启处理 表8 security_groups字段数据结构说明 参数 参数类型 描述 id String 安全组ID 表9 tags字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度36个unicode字符。key不能为空。 同一资源的key值不能重复。 只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）以及中文字符。 value 否 String 值。 每个值最大长度43个unicode字符，可以为空字符串。 value值只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）、小数点（.）以及中文字符。

URI GET /autoscaling-api/v1/{project_id}/scaling_group 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤，请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_group_name 否 String 伸缩组名称。 支持模糊匹配。 scaling_configuration_id 否 String 伸缩配置ID，通过查询弹性伸缩配置列表接口获取，请参考查询弹性伸缩配置列表。 scaling_group_status 否 String 伸缩组状态，取值如下： INSERVICE：正常状态 PAUSED：停用状态 ERROR：异常状态 DELETING：删除中 FREEZED：已冻结 start_number 否 Integer 查询的起始行号，默认为0。最小值为0，最大值没有限制。 limit 否 Integer 查询的记录条数，默认为20。取值范围为：0~100。 enterprise_project_id 否 String 企业项目ID，当传入all_granted_eps时表示查询该用户所有授权的企业项目下的伸缩组列表，如何获取企业项目ID，请参考查询企业项目列表。 说明： 华为云帐号和拥有全局权限的 IAM 用户可以查询该用户所有伸缩组列表。 授予部分企业项目的IAM用户，如果拥有超过100个企业项目，则只能返回有权限的前100个企业项目对应的伸缩组列表。

请求示例 查询伸缩组名称为as-group-test且伸缩配置ID为1d281494-6085-4579-b817-c1f813be835f的伸缩组列表。 GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f

请求示例 创建一个伸缩组，伸缩组名称为GroupNameTest，伸缩配置ID为47683a91-93ee-462a-a7d7-484c006f4440，虚拟私有云ID为a8327883-6b07-4497-9c61-68d03ee193a，网卡ID为3cd35bca-5a10-416f-8994-f79169559870，最大实例数为10，期望实例数为0，最小实例数为0，健康检查方式为云服务器健康检查，设置具体企业项目，伸缩组扩缩容时目标AZ选择的优先级策略为PICK_FIRST（选择优先）。

返回值 正常 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 请求参数 参数 是否必选 参数类型 描述 scaling_group_name 是 String 伸缩组名称(1-64个字符)，只能包含中文、字母、数字、下划线或中划线。 scaling_configuration_id 是 String 伸缩配置ID，通过查询弹性伸缩配置列表接口获取，请参考查询弹性伸缩配置列表。 desire_instance_number 否 Integer 期望实例数量，默认值为最小实例数。 最小实例数≤期望实例数≤最大实例数。 min_instance_number 否 Integer 最小实例数量，默认值为0。 max_instance_number 否 Integer 最大实例数量，默认值为1。取值范围为0-300的整数。 cool_down_time 否 Integer 冷却时间，取值范围0-86400，默认为300，单位是秒。 在每次伸缩活动完成之后，系统开始计算冷却时间。伸缩组在冷却时间内，会拒绝告警策略的触发，其他类型的伸缩策略（如定时策略和周期策略）及手动触发不受限制。 说明： 伸缩组在进行扩容活动过程中，允许缩容策略的触发，扩容活动结束后执行缩容活动，不受冷却时间影响。 伸缩组在进行缩容活动过程中，允许扩容策略的触发，缩容活动结束后执行扩容活动，不受冷却时间影响。 lb_listener_id 否 String 弹性负载均衡监听器ID，最多支持绑定6个负载均衡监听器，多个负载均衡监听器ID以逗号分隔。获取监听器ID的方法请参考查询负载均衡器列表。 该字段与lbaas_listeners互斥。 lbaas_listeners 否 Array of lbaas_listeners objects 弹性负载均衡器信息，最多支持绑定6个负载均衡。列表数据结构请参考表3。获取负载均衡器的信息请参考查询后端云服务器组。 该字段与lb_listener_id互斥。 available_zones 否 Array of strings 可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区，会由系统自动指定可用区。详情请参考地区和终端节点。 networks 是 Array of networks objects 网络信息，最多支持选择5个子网，传入的第一个子网默认作为云服务器的主网卡。获取子网信息请参考查询子网列表。数据结构信息请参考表4。 security_groups 否 Array of security_groups objects 安全组信息，仅支持选择1个安全组。获取安全组信息请参考查询安全组列表。数据结构信息请参考表7。 当伸缩配置和伸缩组同时指定安全组时，将以伸缩配置中的安全组为准；当伸缩配置和伸缩组都没有指定安全组时，增加的弹性云服务器将使用默认安全组。为了使用灵活性更高，推荐在伸缩配置中指定安全组。 vpc_id 是 String 虚拟私有云（VPC）信息，获取VPC信息具体操作请参考查询VPC列表。 health_periodic_audit_method 否 String 伸缩组实例健康检查方式：ELB_AUDIT和NOVA_AUDIT。当伸缩组设置负载均衡时，默认为ELB_AUDIT；否则默认为NOVA_AUDIT。 ELB_AUDIT：负载均衡健康检查方式，在有监听器的伸缩组中有效。 NOVA_AUDIT：云服务器健康检查方式，是弹性伸缩自带的健康检查方式。 health_periodic_audit_time 否 Integer 伸缩组实例的健康检查周期，可设置为1、5、15、60、180（分钟），若不设置该参数，默认为5。 若设置为0，可以实现10秒级健康检查。 health_periodic_audit_grace_period 否 Integer 伸缩组实例健康状况检查宽限期，取值范围0-86400，单位是秒，默认为600。 当实例加入伸缩组并且进入已启用状态后，健康状况检查宽限期才会启动，伸缩组会等健康状况检查宽限期结束后才检查实例的运行状况。 当伸缩组实例健康检查方式为ELB_AUDIT时，该参数生效。 instance_terminate_policy 否 String 伸缩组实例移除策略： OLD_CONFIG_OLD_INSTANCE（默认）：从“较早创建的配置”创建的实例中选择较早创建的实例进行优先移除。 OLD_CONFIG_NEW_INSTANCE：从“较早创建的配置”创建的实例中选择较晚创建的实例进行优先移除。 OLD_INSTANCE：较早创建的实例被优先移除。 NEW_INSTANCE：较晚创建的实例将被优先移除。 notifications 否 Array of strings 通知方式： EMAIL为发送邮件通知。 该通知方式已经被废除，建议给弹性伸缩组配置通知功能。请参考通知。 delete_publicip 否 Boolean 配置删除云服务器时（即进行实例缩容时，将云服务器从伸缩组中移出）是否删除云服务器绑定的弹性IP。取值为true或false，默认为false。 true：删除云服务器时，会同时删除绑定在云服务器上的弹性IP。当弹性IP的计费方式为包年包月时，不会被删除。 false：删除云服务器时，仅解绑定在云服务器上的弹性IP，不删除弹性IP。 delete_volume 否 Boolean 配置删除云服务器时（即进行实例缩容时，将云服务器从伸缩组中移出）是否删除云服务器绑定的数据盘。取值为true或false，默认为false。 true：删除云服务器时，会同时删除绑定在云服务器上的数据盘。当数据盘的计费方式为包年包月时，不会被删除。 false：删除云服务器时，仅解绑定在云服务器上的数据盘，不删除数据盘。 enterprise_project_id 否 String 企业项目ID，用于指定伸缩组归属的企业项目。 取值为0或无该值，表示属于default企业项目。 取值为UUID，表示属于该UUID对应的企业项目，如何获取企业项目ID，请参考查询企业项目列表。 当伸缩组配置企业项目时，由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。 说明： 关于企业项目特性的详细信息，请参见企业项目管理。 multi_az_priority_policy 否 String 伸缩组扩缩容时目标AZ选择的优先级策略： EQUILIBRIUM_DISTRIBUTE（默认）：均衡分布，云服务器扩缩容时优先保证available_zones列表中各AZ下虚拟机数量均衡，当无法在目标AZ下完成虚拟机扩容时，按照PICK_FIRST原则选择其他可用AZ。 PICK_FIRST：选择优先，虚拟机扩缩容时目标AZ的选择按照available_zones列表的顺序进行优先级排序。 description 否 String 伸缩组描述（1-256个字符）。 iam_agency_name 否 String 委托（1-64个字符）。 iam_agency_name为空或者无值则不传递该字段。 iam_agency_name不为空则向下传递。 tags 否 Array of tags objects 创建特定标签并将其添加到伸缩组。每个伸缩组最多添加10个标签。 详情请参考表8。 表3 lbaas_listeners字段数据结构说明 参数 是否必选 参数类型 描述 pool_id 是 String 后端云服务器组ID protocol_port 是 Integer 后端协议号，指后端云服务器监听的端口，取值范围[1, 65535]。 weight 是 Integer 权重，指后端云服务器经分发得到的请求数量的比例，取值范围[0, 100]。 protocol_version 否 String 绑定到负载均衡云服务器组的IP地址版本，枚举值支持ipv4和ipv6。 说明： 伸缩组实例不支持多网卡双栈，仅支持首网卡双栈，其他网卡地址会被忽略。首网卡是指从弹性云服务器查询到的第一张支持所选IP地址版本的网卡，可能是主网卡，也可能是扩展网卡。 只有选择支持IPv6的弹性云服务器，才可以使用IPv4/IPv6双栈网络，请务必选择支持的区域和规格。 当pool_id、protocol_port、protocol_version均一致时，会进行去重。 表4 networks字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 子网的网络ID。 ipv6_enable 否 Boolean 是否启用IPv6。 true：标识此网卡已启用ipv6。 false：标识此网卡未启用ipv6。默认取值为false。 ipv6_bandwidth 否 ipv6_bandwidth object 绑定的IPv6共享带宽。默认为空，表示未绑定IPv6的共享带宽。 allowed_address_pairs 否 Array of allowed_address_pairs objects 是否开启源/目的检查开关。 表5 ipv6_bandwidth字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String IPv6共享带宽的ID 表6 allowed_address_pairs字段数据结构说明 参数 是否必选 参数类型 描述 ip_address 否 String 是否开启源/目的检查开关。 默认是开启，不允许置空。 关闭：1.1.1.1/0 开启：除“1.1.1.1/0”以外的其余值均按开启处理 表7 security_groups字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 安全组ID 表8 tags字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度36个unicode字符。key不能为空。 同一资源的key值不能重复。 只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）以及中文字符。 value 否 String 值。 每个值最大长度43个unicode字符，可以为空字符串。 value值只能包含大写字母（A~Z）、小写字母（a~z）、数字（0-9）、下划线（_）、中划线（-）、小数点（.）以及中文字符。

功能介绍 伸缩组是具有相同应用场景的实例的集合，是启停伸缩策略和进行伸缩活动的基本单位。伸缩组内定义了最大实例数、期望实例数、最小实例数、虚拟私有云、子网、负载均衡等信息。 默认最多可以创建10个伸缩组。 如果伸缩组配置了负载均衡，在添加或移除实例时，会自动为实例绑定或解绑负载均衡监听器。 如果伸缩组使用负载均衡健康检查方式，伸缩组中的实例需要启用负载均衡器的监听端口才能通过健康检查。端口启用可在安全组中进行配置，可参考添加安全组规则进行操作。 如果您将多个负载均衡器添加到伸缩组，则只有在所有负载均衡器均检测到云服务器状态为正常的情况下，才会认为该弹性云服务器正常。否则只要有一个负载均衡器检测到云服务器状态异常，伸缩组会将该弹性云服务器移出伸缩组。 如果您将负载均衡器的多个端口绑定到伸缩组，则只有在所有端口均检测到云服务器状态为正常的情况下，才会认为该弹性云服务器正常。否则只要有一个端口检测到云服务器状态异常，伸缩组会将该弹性云服务器移出伸缩组。 当实例绑定负载均衡器的多个端口时，推荐伸缩策略与云服务器实例告警指标关联，避免伸缩策略与单一业务或网络指标关联，否则当不同告警指标分别指向扩容和缩容时，会导致扩缩容同时触发。 弹性伸缩活动中，若实例与负载均衡器的多个端口依次绑定或解绑，未全部成功时，则认为实例伸缩失败。扩容触发实例释放并创建新实例，缩容失败不释放实例。

弹性伸缩组 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建弹性伸缩组 POST /autoscaling-api/v1/{project_id}/scaling_group as:groups:create √ √ 查询弹性伸缩组列表 GET /autoscaling-api/v1/{project_id}/scaling_group as:groups:list √ √ 查询弹性伸缩组详情 GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id} as:groups:get √ √ 修改弹性伸缩组 PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id} as:groups:update √ √ 删除弹性伸缩组 DELETE /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id} as:groups:delete √ √ 启用或停止弹性伸缩组 POST /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action as:groups:action √ √ 父主题： 权限和授权项

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": $ADMIN_PASS, //IAM用户密码，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 123 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint，比如“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于管理员创建IAM用户接口，使用AK/SK方式认证时，添加消息头后的请求如下所示。 1234 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=****************

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“X-Subject-Token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

操作步骤 Token认证，具体操作请参考认证鉴权。 获取项目ID（project_id），具体操作请参考获取项目ID。 在Request Header中增加“Content-Type”键，值为“application/json”。 在Request Header中增加“X-Auth-Token”键，值为1获取到的token。 发送“POST https://AS的Endpoint/v1/{project_id}/scaling_group”，project_id为2获取到的项目ID。 在Request Body中传入参数如下： { "scaling_group_name": "GroupNameTest",//伸缩组名称（必填String） "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440",//伸缩配置ID（非必填String，但启动伸缩组时组内必有伸缩配置） "desire_instance_number": 0,//期望实例数（非必填Integer） "min_instance_number": 0,//最小实例数（非必填Integer） "max_instance_number": 0,//最大实例数（非必填Integer） "cool_down_time": 200,//冷却时间（非必填Integer） "health_periodic_audit_method": "NOVA_AUDIT",//伸缩组实例健康检查方式（非必填String） "health_periodic_audit_time": 5,//伸缩组实例健康检查周期（非必填Integer） "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",//伸缩组实例移除策略（非必填String） "vpc_id": "a8327883-6b07-4497-9c61-68d03ee193a",//VPC信息（必填String） "networks": [ { "id": "3cd35bca-5a10-416f-8994-f79169559870" } ]//子网信息（必填列表数据结构）} 请求响应成功后，返回scaling_group_id。表示弹性伸缩组创建成功。 若请求失败，则会返回错误码及对应的错误信息说明，详细请参考错误码。 根据获取到的scaling_group_id，可对弹性伸缩组进行查询、修改、删除等操作。

API概览 通过使用弹性伸缩所提供的接口，您可以完整的使用弹性伸缩的所有功能，例如创建伸缩组。弹性伸缩支持的接口见表1。 表1 弹性伸缩接口说明 子类型 说明 弹性伸缩组 实现伸缩组的创建、查询、修改、删除等操作。 弹性伸缩配置 实现伸缩配置的创建、查询、删除等操作。 弹性伸缩实例 实现伸缩实例的查询、移出伸缩组等操作。 弹性伸缩策略 实现伸缩策略的创建、查询、修改、删除等操作。 伸缩策略执行日志 查询伸缩策略执行的历史记录。 伸缩活动日志 查询伸缩活动日志。 配额 查询指定租户的弹性伸缩组、伸缩配置、伸缩策略和伸缩实例的配额总数及已使用配额数。 通知 提供配置伸缩组通知、查询伸缩组通知列表和删除伸缩组通知功能。 生命周期挂钩 提供创建、查询、修改和删除生命周期挂钩等功能。 标签管理 提供查询租户或资源标签、创建或删除标签和查询资源实例的功能。 弹性伸缩API管理 提供查询弹性伸缩API版本信息的功能。

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65ewtrgaggshhk1223245sghjlse684b", "is_domain": false, "parent_id": "65ewtrgaggshhk1223245sghjlse684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg" }, "id": "a4adasfjljaaaakla12334jklga9sasfg", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": The request message format is invalid.", "error_code": "AS.0001"} 其中，error_code表示错误码，error_msg表示错误描述信息。

返回值 正常 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 网关超时。

使用须知 请勿将该 DLI 作业桶绑定的OBS桶用作其它用途，避免出现作业结果混乱等问题。 DLI作业要由用户主账户统一设置及修改，子用户无权限。 不配置DLI作业桶无法查看作业日志。 您可以通过配置桶的生命周期规则，定时删除桶中的对象或者定时转换对象的存储类别。 DLI的作业桶设置后请谨慎修改，否则可能会造成历史数据无法查找。 Spark日志分割规则： 按大小分割：默认情况下，每个日志文件最大为128MB。 按时间分割：每过一小时自动创建新的日志文件。