华为云用户手册

  • 响应参数 表1 响应参数 参数 参数类型 描述 versions Array of versions objects 描述弹性伸缩API版本信息列表。 表2 versions字段数据结构说明 参数 参数类型 描述 id String API版本ID links Array of links objects API 的url地址,详情请见表3 links字段数据结构说明。 min_version String API支持的最小微版本号。 status String API版本状态: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还在继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String API版本发布时间 version String API支持的最大微版本号 表3 links字段数据结构说明 参数 参数类型 描述 href String API的url地址 rel String API的url地址依赖
  • 响应示例 { "versions": [ { "id": "v1", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2016-06-30T00:00:00Z", "version": "" }, { "id": "v2", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v2/", "rel": "self" } ], "min_version": "", "status": "SUPPORTED", "updated": "2018-03-30T00:00:00Z", "version": "" } ]}
  • API概览 通过使用弹性伸缩所提供的接口,您可以完整的使用弹性伸缩的所有功能,例如创建伸缩组。弹性伸缩支持的接口见表1。 表1 弹性伸缩接口说明 子类型 说明 弹性伸缩组 实现伸缩组的创建、查询、修改、删除等操作。 弹性伸缩配置 实现伸缩配置的创建、查询、删除等操作。 弹性伸缩实例 实现伸缩实例的查询、移出伸缩组等操作。 弹性伸缩策略 实现伸缩策略的创建、查询、修改、删除等操作。 伸缩策略执行日志 查询伸缩策略执行的历史记录。 伸缩活动日志 查询伸缩活动日志。 配额 查询指定租户的弹性伸缩组、伸缩配置、伸缩策略和伸缩实例的配额总数及已使用配额数。 通知 提供配置伸缩组通知、查询伸缩组通知列表和删除伸缩组通知功能。 生命周期挂钩 提供创建、查询、修改和删除生命周期挂钩等功能。 标签管理 提供查询租户或资源标签、创建或删除标签和查询资源实例的功能。 弹性伸缩API管理 提供查询弹性伸缩API版本信息的功能。
  • 监控指标 指标 指标名称 含义 取值范围 备注 cpu_util CPU使用率 该指标用于统计测量对象中所有云服务器的CPU使用率的均值。 ≥0% 测量对象为弹性伸缩组。 mem_util 内存使用率 该指标用于统计测量对象中所有云服务器的内存使用率的均值。 ≥0% 测量对象为弹性伸缩组。 说明: 如果用户使用的镜像未安装vmtools,则无法获取该监控指标。 network_incoming_bytes_rate_inband 带内网络流入速率 该指标用于统计测量对象中所有云服务器的网络流入速率的均值。 ≥0 Byte/s 测量对象为弹性伸缩组。 network_outgoing_bytes_rate_inband 带内网络流出速率 该指标用于统计测量对象中所有云服务器的网络流出速率的均值。 ≥0 Byte/s 测量对象为弹性伸缩组。 instance_num 实例数 该指标用于统计测量对象中可用的云服务器数量。 ≥0 测量对象为弹性伸缩组。 可用的云服务器是指伸缩组中生命周期状态为“INSERVICE”的实例。 disk_read_bytes_rate 磁盘读速率 该指标用于统计每秒从测量对象中所有云服务器读出的数据量,以字节/秒为单位。 ≥0 Byte/s 测量对象为弹性伸缩组。 disk_write_bytes_rate 磁盘写速率 该指标用于统计每秒写到测量对象中所有云服务器的数据量,以字节/秒为单位。 ≥0 Byte/s 测量对象为弹性伸缩组。 disk_read_requests_rate 磁盘读操作速率 该指标用于统计每秒从测量对象中所有云服务器读取数据的请求次数,以请求/秒为单位。 ≥0 request/s 测量对象为弹性伸缩组。 disk_write_requests_rate 磁盘写操作速率 该指标用于统计每秒往测量对象中所有云服务器写数据的请求次数,以请求/秒为单位。 ≥0 request/s 测量对象为弹性伸缩组。 对于不同的操作系统,监控指标“内存使用率”、“带内网络流出速率”和“带内网络流入速率”是否支持,详细信息请参见《弹性云服务器用户指南》。
  • 响应参数 表2 响应参数 参数 参数类型 描述 version version object 描述弹性伸缩API指定版本信息。 表3 version字段数据结构说明 参数 参数类型 描述 id String API版本ID links Array of links objects API 的url地址,详情请见表4 links字段数据结构说明。 min_version String API支持的最小微版本 status String API版本状态: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还在继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String API版本发布时间 version String API支持的最大微版本号 表4 links字段数据结构说明 参数 参数类型 描述 href String API的url地址 rel String API的url地址依赖
  • 响应示例 { "version": { "id": "v1", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2016-06-30T00:00:00Z", "version": "" }}
  • 返回值 正常 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获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}
  • 操作步骤 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,可对弹性伸缩组进行查询、修改、删除等操作。
  • 返回值 正常 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]。 表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。
  • 返回值 正常 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 DELETE /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_ configuration _id 是 String 伸缩配置ID,可参考查询弹性伸缩配置列表获取。
  • 返回值 正常 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 网关超时。
  • 返回值 正常 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 网关超时。
  • 响应示例 { "limit": 10, "total_number": 1, "start_number": 0, "scaling_group_instances": [ { "instance_id": "b25c1589-c96c-465b-9fef-d06540d1945c", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "scaling_group_name": "discuz", "life_cycle_state": "INSERVICE", "health_status": "NORMAL", "scaling_configuration_name": "discuz", "scaling_configuration_id": "ca3dcd84-d197-4c4f-af2a-cf8ba39696ac", "create_time": "2015-07-23T06:47:33Z", "instance_name": "discuz_3D210808", "protect_from_scaling_down": false } ]}
  • 返回值 正常 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 GET /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/list 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_group_id 是 String 伸缩组ID。 life_cycle_state 否 String 实例在伸缩组中的生命周期状态: INSERVICE:已启用 PENDING:正在加入伸缩组 PENDING_WAIT:等待(正在加入伸缩组) REMOVING:正在移出伸缩组 REMOVING_WAIT:等待(正在移出伸缩组) STANDBY:已备用 ENTERING_STANDBY:进入备用状态 health_status 否 String 实例健康状态: INITIALIZING:初始化 NORMAL:正常 ERROR:异常 protect_from_scaling_down 否 String 实例保护状态: true:已设置实例保护。 false:未设置实例保护。 start_number 否 Integer 查询的起始行号,默认为0。最小值为0。 limit 否 Integer 查询的记录条数,默认为20。取值范围为:0~100。
  • 请求示例 查询ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组下已启用且处于健康状态的实例。 GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?life_cycle_state=INSERVICE&health_status=NORMAL
  • 响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_group_instances Array of scaling_group_instances objects 伸缩组实例详情 表3 scaling_group_instances字段数据结构说明 参数 参数类型 描述 instance_id String 实例ID instance_name String 实例名称 scaling_group_id String 实例所在伸缩组ID scaling_group_name String 实例所在伸缩组名称。 支持模糊匹配。 life_cycle_state String 实例在伸缩组中的生命周期状态: INSERVICE:已启用 PENDING:正在加入伸缩组 PENDING_WAIT:等待(正在加入伸缩组) REMOVING:正在移出伸缩组 REMOVING_WAIT:等待(正在移出伸缩组) STANDBY:已备用 ENTERING_STANDBY:进入备用状态 health_status String 实例健康状态: INITAILIZING:初始化。 NORMAL:正常。 ERROR:错误。 scaling_configuration_name String 伸缩配置名称。 scaling_configuration_id String 伸缩配置ID。 若返回不为空,表示该实例为弹性伸缩自动创建的ECS实例。 若返回为空,表示该实例为用户手动添加到伸缩组的ECS实例。 create_time String 实例加入伸缩组时间,遵循UTC时间。 protect_from_scaling_down Boolean 实例的实例保护属性。
  • 返回值 正常 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 DELETE /autoscaling-api/v1/{project_id}/scaling_group_instance/{instance_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID,可参考查询弹性伸缩组中的实例列表获取。 instance_delete 否 String 实例移出伸缩组时,是否删除该实例。 取值如下: 不删除实例:no,默认为no。 删除实例:yes
  • 返回值 正常 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 网关超时。
  • 请求示例 批量移出并删除ID为e5d27f5c-dd76-4a61-b4bc-a67c5686719a的伸缩组中,实例ID为instance_id_1和instance_id_2的两个实例。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action{ "action": "REMOVE", "instances_id": [ "instance_id_1", "instance_id_2" ], "instance_delete": "yes"}
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 instances_id 是 Array of strings 云服务器ID instance_delete 否 String 从伸缩组中移出实例时,是否删除云服务器。 取值如下: no:不删除实例,默认情况为no。 yes:删除实例。 如果是手动添加到伸缩组的实例,只能从伸缩组中移出,不支持移出并删除。 只有action为REMOVE时,这个字段才生效。 instance_append 否 String 将实例移入备用状态时,是否补充新的云服务器。 取值如下: no:不补充新的实例,默认情况为no。 yes:补充新的实例。 只有action为ENTER_STANDBY时,这个字段才生效。 action 是 String 批量操作实例action标识: 添加:ADD 移除:REMOVE 设置实例保护:PROTECT 取消实例保护:UNPROTECT 转入备用状态:ENTER_STANDBY 移出备用状态:EXIT_STANDBY
  • 功能介绍 批量移出伸缩组中的实例或批量添加伸缩组外的实例。 批量移出伸缩组时,如果是手动添加到伸缩组的实例,只能从伸缩组中移出,不支持移出并删除。 批量对伸缩组中的实例设置或取消其实例保护属性。 批量将伸缩组中的实例转入或移出备用状态。 单次最多批量操作实例个数为50。批量添加后实例数不能大于伸缩组的最大实例数,批量移出后实例数不能小于伸缩组的最小实例数。 当伸缩组处于INSERVICE状态且没有伸缩活动时,才能添加实例。 当伸缩组没有伸缩活动时,才能移出实例。 向伸缩组中添加实例时,必须保证实例所在的可用区包含于伸缩组的可用区内。 实例处于INSERVICE状态时才可以进行移出、设置或取消实例保护属性等操作。 当伸缩组发生自动缩容活动时,设置了实例保护的实例不会被移出伸缩组。 批量移出弹性伸缩组中的实例时,若该实例加入伸缩组时绑定的监听器和伸缩组本身的监听器相同,会解绑定实例和监听器。若该实例加入伸缩组时绑定的监听器和伸缩组本身的监听器不同,会保留实例和监听器的绑定关系。
  • 返回值 正常 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 DELETE /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_group_id 是 String 伸缩组ID。 force_delete 否 String 是否强制删除伸缩组。取值如下: no:不强制删除伸缩组,默认为no。 yes:强制删除伸缩组。
  • 功能介绍 删除一个指定弹性伸缩组。 force_delete属性表示如果伸缩组存在ECS实例或正在进行伸缩活动,是否强制删除伸缩组并移出和释放ECS实例。默认值为no,表示不强制删除伸缩组。 如果force_delete的值为no,必须满足以下两个条件,才能删除伸缩组: 条件一:伸缩组没有正在进行的伸缩活动。 条件二:伸缩组当前的ECS实例数量(current_instance_number)为0。 如果force_delete的值为yes,伸缩组会被置于DELETING状态,拒绝接收新的伸缩活动请求,然后等待已有的伸缩活动完成,最后将伸缩组内所有ECS实例移出伸缩组(用户手动添加的ECS实例会被移出伸缩组,弹性伸缩自动创建的ECS实例会被自动删除)并删除伸缩组。
共100000条