云服务器内容精选

  • 返回值 正常 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 网关超时。
  • 响应示例 { "scaling_configuration": { "tenant": "ce061903a53545dcaddb300093b477d2", "scaling_configuration_id": "6afe46f9-7d3d-4046-8748-3b2a1085ad86", "scaling_configuration_name": " config_name_1", "instance_config": { "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS" }, { "size": 100, "volume_type": "SATA", "disk_type": "DATA" } ], "adminPass": "***", "personality": null, "instance_name": null, "instance_id": null, "flavorRef": "103", "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c", "key_name": "keypair01", "key_fingerprint" : "SHA256:qlvdUkYgSjKUxcr2uJgJJRMCKMLkJO5BPLooBcgsF8k", "public_ip": null, "user_data": null, "metadata": {}, "security_groups": [{ "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" }], "multi_flavor_priority_policy": "PICK_FIRST" }, "create_time": "2015-07-23T01:04:07Z" } }
  • 响应消息 响应参数 表2 响应参数 参数 参数类型 描述 scaling_configuration scaling_configurations object 伸缩配置详情 表3 scaling_configurations字段数据结构说明 参数 参数类型 描述 scaling_configuration_id String 伸缩配置ID,全局唯一。 tenant String 租户ID。 scaling_configuration_name String 伸缩配置名称。 支持模糊匹配。 instance_config instance_config object 实例配置信息。 create_time String 创建伸缩配置时间,遵循UTC时间。 scaling_group_id String 绑定该伸缩配置的伸缩组ID。 表4 instance_config字段数据结构说明 参数 参数类型 描述 flavorRef String 云服务器的规格ID。 imageRef String 镜像ID,同image_id。 disk Array of disk objects 磁盘组信息。 key_name String 登录云服务器的SSH密钥名称。 key_fingerprint String 登录云服务器的SSH密钥指纹。 instance_name String 该参数为预留字段。 说明: 使用已有云服务器规格为模板创建的伸缩配置,查询伸缩配置和列表接口时instance_name为空 instance_id String 该参数为预留字段。 adminPass String 该参数为预留字段。 personality Array of personality objects 注入文件信息。 public_ip public_ip object 云服务器的弹性IP信息。 user_data String cloud-init用户数据,base64格式编码。 metadata metadata object 创建云服务器元数据,详情见表11。 security_groups Array of security_groups objects 安全组信息。 server_group_id String 云服务器组ID。 tenancy String 在专属主机上创建弹性云服务器。 dedicated_host_id String 专属主机的ID。 market_type String 云服务器的计费模式,可以选择竞价计费或按需计费。 multi_flavor_priority_policy String 使用伸缩配置创建云主机的时候,多规格使用的优先级策略。 。 表5 disk字段数据结构说明 参数 参数类型 描述 size Integer 磁盘大小,容量单位为GB。 volume_type String 磁盘类型。 disk_type String 系统盘还是数据盘,DATA表示为数据盘,SYS表示为系统盘。 dedicated_storage_id String 磁盘所属的专属存储ID。 data_disk_image_id String 导入数据盘的数据盘镜像ID。 snapshot_id String 磁盘备份的快照ID。 metadata metadata object 创建磁盘的元数据,详情见表6。 iops Integer 云硬盘的iops。当“volume_type”设置为GPSSD2、ESSD2类型的云硬盘时,该参数可以设置。 说明: 了解GPSSD2、ESSD2类型云硬盘的iops,请参见磁盘类型及性能介绍。 仅支持按需计费。 throughput Integer 云硬盘的吞吐量,单位是MiB/s。当“volume_type”设置为GPSSD2类型的云硬盘时,该参数可以设置。 说明: 了解GPSSD2类型云硬盘的吞吐量大小范围,请参见磁盘类型及性能介绍。 仅支持按需计费。 表6 personality字段数据结构说明 参数 参数类型 描述 path String 注入文件路径信息。 content String 注入文件内容,base64格式编码。 表7 public_ip字段数据结构说明 参数 参数类型 描述 eip eip object 云服务器自动分配弹性IP时,创建弹性IP的配置参数。 表8 eip字段数据结构说明 参数 参数类型 描述 ip_type String IP地址类型 bandwidth bandwidth object IP地址带宽参数 表9 bandwidth字段数据结构说明 参数 参数类型 描述 size Integer 带宽(Mbit/s)。 share_type String 带宽的共享类型。 共享类型枚举: PER:独享型。 WHOLE:共享型。 charging_mode String 带宽的计费类型。 bandwidth:按带宽计费。 traffic:按流量计费。 id String 带宽ID,创建WHOLE类型带宽的弹性IP时指定的共享带宽。 表10 metadata字段数据结构说明 参数 参数类型 描述 admin_pass String Windows弹性云服务器Administrator用户的密码。 表11 security_groups字段数据结构说明 参数 参数类型 描述 id String 安全组ID
  • URI GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id} 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_configuration_id 是 String 伸缩配置ID,该ID对应全局唯一配置。可参考查询弹性伸缩配置详情获取。
  • 响应示例 { "limit": 20, "total_number": 2, "start_number": 0, "scaling_configurations": [ { "tenant": "ce061903a53545dcaddb300093b477d2", "scaling_configuration_id": "6afe46f9-7d3d-4046-8748-3b2a1085ad86", "scaling_configuration_name": " config_name_1", "instance_config": { "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS", "cluster_type" : "DSS", "hw:passthrough": true, "multiattach": false }, { "size": 100, "volume_type": "SATA", "disk_type": "DATA" } ], "personality": null, "instance_name": null, "instance_id": null, "flavorRef": "103", "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c", "key_name": "keypair01", "key_fingerprint" : "SHA256:qlvdUkYgSjKUxcr2uJgJJRMCKMLkJO5BPLooBcgsF8k", "public_ip": null, "user_data": null, "metadata": {}, "security_groups": [{ "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" }], "support_auto_recovery" : null, "disk_prior" : null, "cpu_options" : null, "is_auto_rename" : false, "instance_metadata" : null }, "create_time": "2015-07-23T01:04:07Z" }, { "tenant": "ce061903a53545dcaddb300093b477d2", "scaling_configuration_id": "24a8c5f3-c713-4aba-ac29-c17101009e5d", "scaling_configuration_name": "config_name_2", "instance_config": { "disk": [ { "size": 40, "volume_type": "SATA", "disk_type": "SYS" } ], "personality": null, "instance_name": null, "instance_id": null, "flavorRef": "103", "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c", "key_name": "keypair01", "key_fingerprint" : "SHA256:qlvdUkYgSjKUxcr2uJgJJRMCKMLkJO5BPLooBcgsF8k", "public_ip": null, "user_data": null, "metadata": {}, "security_groups": [{ "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be" }], "multi_flavor_priority_policy": "PICK_FIRST" }, "create_time": "2015-07-22T01:08:41Z" } ] }
  • 返回值 正常 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_configurations Array of scaling_configurations objects 伸缩配置列表。 表3 scaling_configurations字段数据结构说明 参数 参数类型 描述 scaling_configuration_id String 伸缩配置ID,全局唯一。 tenant String 租户ID。 scaling_configuration_name String 伸缩配置名称。 支持模糊匹配。 instance_config instance_config object 实例配置信息。 create_time String 创建伸缩配置时间,遵循UTC时间。 scaling_group_id String 绑定该伸缩配置的伸缩组ID。 表4 instance_config字段数据结构说明 参数 参数类型 描述 flavorRef String 云服务器的规格ID。 imageRef String 镜像ID,同image_id。 disk Array of disk objects 磁盘组信息。 key_name String 登录云服务器的SSH密钥名称。 key_fingerprint String 登录云服务器的SSH密钥指纹。 instance_name String 该参数为预留字段。 说明: 使用已有云服务器规格为模板创建的伸缩配置,查询伸缩配置和列表接口时instance_name为空 instance_id String 该参数为预留字段。 adminPass String 该参数为预留字段。 personality Array of personality objects 注入文件信息。 public_ip public_ip object 云服务器的弹性IP信息。 user_data String cloud-init用户数据,base64格式编码。 metadata metadata object 创建云服务器元数据,详情见表11。 security_groups Array of security_groups objects 安全组信息。 server_group_id String 云服务器组ID。 tenancy String 在专属主机上创建弹性云服务器。 dedicated_host_id String 专属主机的ID。 market_type String 云服务器的计费模式,可以选择竞价计费或按需计费。 multi_flavor_priority_policy String 使用伸缩配置创建云主机的时候,多规格使用的优先级策略。 。 表5 disk字段数据结构说明 参数 参数类型 描述 size Integer 磁盘大小,容量单位为GB。 volume_type String 磁盘类型。 disk_type String 系统盘还是数据盘,DATA表示为数据盘,SYS表示为系统盘。 dedicated_storage_id String 磁盘所属的专属存储ID。 data_disk_image_id String 导入数据盘的数据盘镜像ID。 snapshot_id String 磁盘备份的快照ID。 metadata metadata object 创建磁盘的元数据,详情见表6。 iops Integer 云硬盘的iops。当“volume_type”设置为GPSSD2、ESSD2类型的云硬盘时,该参数可以设置。 说明: 了解GPSSD2、ESSD2类型云硬盘的iops,请参见磁盘类型及性能介绍。 仅支持按需计费。 throughput Integer 云硬盘的吞吐量,单位是MiB/s。当“volume_type”设置为GPSSD2类型的云硬盘时,该参数可以设置。 说明: 了解GPSSD2类型云硬盘的吞吐量大小范围,请参见磁盘类型及性能介绍。 仅支持按需计费。 表6 创建磁盘的metadata字段数据结构说明 参数 参数类型 描述 __system__encrypted String metadata中的表示加密功能的字段,0代表不加密,1代表加密。 该字段不存在时,云硬盘默认为不加密。 __system__cmkid String 用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。 说明: 请参考查询密钥列表,通过HTTPS请求获取密钥ID。 表7 personality字段数据结构说明 参数 参数类型 描述 path String 注入文件路径信息。 content String 注入文件内容,base64格式编码。 表8 public_ip字段数据结构说明 参数 参数类型 描述 eip eip object 云服务器自动分配弹性IP时,创建弹性IP的配置参数。 表9 eip字段数据结构说明 参数 参数类型 描述 ip_type String IP地址类型。 bandwidth bandwidth object IP地址带宽参数。 表10 bandwidth字段数据结构说明 参数 参数类型 描述 size Integer 带宽(Mbit/s)。 share_type String 带宽的共享类型。 共享类型枚举: PER:独享型。 WHOLE:共享型。 charging_mode String 带宽的计费类型。 bandwidth:按带宽计费。 traffic:按流量计费。 id String 带宽ID,创建WHOLE类型带宽的弹性IP时指定的共享带宽。 表11 metadata字段数据结构说明 参数 参数类型 描述 admin_pass String Windows弹性云服务器Administrator用户的密码。 表12 security_groups字段数据结构说明 参数 参数类型 描述 id String 安全组ID
  • URI GET /autoscaling-api/v1/{project_id}/scaling_configuration 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 scaling_configuration_name 否 String 伸缩配置名称。 支持模糊匹配。 image_id 否 String 镜像ID,同imageRef。 start_number 否 Integer 查询的起始行号,默认为0。最小值为0。 limit 否 Integer 查询的记录条数,默认为20。取值范围为:0~100。
  • 修订记录 版本日期 变更说明 2024-05-21 第三十一次正式发布。本次变更如下: 创建弹性伸缩组、查询弹性伸缩组列表和查询弹性伸缩组详情章节新增tags参数。 新增错误码“AS.7100”。 2023-10-16 第三十次正式发布。本次变更如下: 创建弹性伸缩配置章节新增source_scaling_configuration_id参数。 2023-08-30 第二十九次正式发布。本次变更如下: 创建弹性伸缩组、查询弹性伸缩组列表、查询弹性伸缩组详情和修改弹性伸缩组章节新增protocol_version参数。 2023-08-17 第二十八次正式发布。本次变更如下: 新增创建计划任务、查询计划任务列表、更新计划任务和删除计划任务章节。 2021-11-20 第二十七次正式发布。本次变更如下: 新增allowed_address_pairs参数,涉及: 创建弹性伸缩组 查询弹性伸缩组列表 查询弹性伸缩组详情 修改弹性伸缩组 2020-09-16 第二十六次正式发布。本次变更如下: 1.“创建弹性伸缩策略(V2版本)、修改弹性伸缩策略(V2版本)、查询弹性伸缩策略列表(V2版本)、查询弹性伸缩策略全量列表(V2版本)、查询弹性伸缩策略详情(V2版本)、查询策略执行日志”章节新增"INTERVAL_ALARM”参数; 2. 新增错误码“AS.3059-AS.3069”。 2020-07-30 第二十六次正式发布。本次变更如下: 新增应用示例章节。 2019-09-30 第二十五次正式发布。本次变更如下: 创建弹性伸缩组、查询弹性伸缩组列表、查询弹性伸缩组详情和修改弹性伸缩组章节新增delete_volume参数。 错误码新增错误码AS.1090。 2019-05-31 第二十四次正式发布。本次变更如下: 伸缩组支持在不停用状态下新增、修改和删除可用区,修改修改弹性伸缩组中available_zones字段相关描述。 错误码新增错误码AS.2054。 全文进行结构优化,新增调用说明、终端节点、约束与限制、基本概念和权限及授权项说明等章节。 支持细粒度授权控制EIP的创建,在创建弹性伸缩配置章节中的public_ip字段增加了说明。 2019-04-30 第二十三次正式发布。本次变更如下: 查询伸缩活动日志(V2版本)章节新增log_id、status字段。 错误码新增错误码AS.9012、AS.9013。 调整章节目录,升级具体接口和错误码的目录层级。 2019-03-31 第二十二次正式发布。本次变更如下: 创建弹性伸缩配置章节新增market_type参数。 新增multi_flavor_priority_policy、multi_az_priority_policy、instance_config、delete_alarm和alarm_id参数。 错误码章节新增错误码AS.1085、AS.1086、AS.1087、AS.1088、AS.2053、AS.7016、AS.1083、AS.1084和AS.3056。 错误码章节修改错误码AS.1017、AS.1018、AS.1032、AS.1036、AS.1078、AS.1080、AS.1081、AS.2038、AS.2043和AS.7011。 2019-01-30 第二十一次正式发布。本次变更如下: 批量操作实例章节新增instance_append参数和实例备用状态相关参数。 查询伸缩活动日志(V2版本)章节新增instance_standby_list字段和实例备用状态相关参数。 错误码新增错误码AS.2051、AS.2052、AS.4036、AS.4037、AS.4038和AS.4039。 2018-12-30 第二十次正式发布。本次变更如下: 创建弹性伸缩配置章节instance_config字段新增tenancy和dedicated_host_id参数。 错误码章节新增错误码AS.1071、AS.1073、AS.1077、AS.1078、AS.1079、AS.1081、AS.2048、AS.2049、AS.2050、AS.1080和AS.1082。 错误码章节修改错误码AS.1068、AS.1075和AS.1076。 创建弹性伸缩组章节新增networks字段。 2018-11-30 第十九次正式发布。本次变更如下: 查询弹性伸缩组中的实例列表章节新增protect_from_scaling_down参数。 新增查询伸缩活动日志(V2版本)章节。 错误码章节新增错误码AS.2047、AS.7066。 错误码章节修改错误码AS.2015、AS.2035和AS.2042。 2018-09-30 第十八次正式发布。本次变更如下: 创建弹性伸缩配置和查询弹性伸缩配置列表章节bandwidth字段新增id参数,优化了其他参数说明。 错误码章节新增错误码AS.1033、AS.1046、AS.1047、AS.1048、AS.1068、AS.1069、AS.1070、AS.1071、AS.1072、AS.1074、AS.1075、AS.1076、AS.7118、AS.3055和AS.8004。 创建弹性伸缩配置新增server_group_id参数。 新增查询弹性伸缩策略全量列表(V2版本)章节。 权限和授权项章节伸缩配置和伸缩策略修改授权作用域。 新增弹性伸缩API管理章节。 调整了大纲结构。 2018-08-30 第十七次正式发布。本次变更如下: 新增查询资源实例章节。 冷却时间默认值变更为300秒。 新增“API授权项列表”章节。 错误码章节新增错误码AS.1067。 弹性伸缩组章节新增enterprise_project_id参数。 2018-07-30 第十六次正式发布。本次变更如下: 创建弹性伸缩组章节健康检查周期支持设置10秒和1分钟。 2018-06-30 第十五次正式发布。本次变更如下: 优化“eip字段数据结构说明”。 优化返回错误码说明。 2018-05-30 第十四次正式发布。本次变更如下: 创建弹性伸缩组新增lbaas_listeners参数。 弹性伸缩配置新增security_groups参数。 查询弹性伸缩策略详情(V2版本)章节新增meta_data参数。 新增批量操作弹性伸缩策略章节。 查询策略执行日志章节新增meta_data参数。 错误码章节修改错误码AS.3004、AS.3008、AS.3009、AS.3010、AS.3033。 错误码章节新增错误码AS.0026、AS.3045、AS.3046、AS.3047、AS.3048、AS.3049。 2018-04-30 第十三次正式发布。本次变更如下: 创建弹性伸缩组章节新增“health_periodic_audit_grace_period”要素说明。 修改弹性伸缩组章节新增“health_periodic_audit_grace_period”要素说明。 查询伸缩组绑定的伸缩策略章节新增“scaling_policy_id”字段。 查询资源绑定的伸缩策略 (V2版本)章节新增“scaling_policy_id”字段。 查询伸缩活动日志章节新增“scaling_policy_id”和“scaling_policy_name”两个字段样例。 错误码章节新增错误码 AS.2046、AS.7044、AS.7045、AS.7047、AS.7048、AS.7049、AS.7050、AS.7055。 2018-03-30 第十二次正式发布。本次变更如下: 新增创建弹性伸缩策略(V2版本)章节。 新增修改弹性伸缩策略(V2版本)章节。 新增查询资源绑定的伸缩策略 (V2版本)章节。 新增查询弹性伸缩策略详情(V2版本)章节。 新增伸缩策略执行日志章节。 查询标签章节中修改Tag字段数据结构说明。 查询资源标签章节中修改ResourceTag字段数据结构说明。 创建或删除标签章节中修改要素说明、ResourceTag字段数据结构说明、返回值。 2018-01-30 第十一次正式发布。本次变更如下: 批量操作实例章节中新增说明字段。 删除弹性伸缩组章节新增强制删除伸缩组参数及功能说明。 弹性伸缩组章节新增弹性负载均衡(经典型)描述。 弹性伸缩配置章节新增snapshot_id参数。 优化返回错误码说明。 2017-11-30 第十次正式发布。本次变更如下: 伸缩策略实例支持百分比方式进行扩容和缩容。 增加了弹性伸缩监控指标。 新增错误码AS.1053~AS.1061、AS.3035、AS.3036、AS.2042、AS.2043、AS.1019和AS.1020。 新增参数dedicated_storage_id和data_disk_image_id。 新增标签管理。 2017-09-30 第九次正式发布。本次变更如下: 查询弹性伸缩组中的实例列表和批量操作实例章节增加实例保护相关内容。 新增错误码4033、4032、2010。 2017-07-30 第八次正式发布。本次变更如下。 修改了磁盘大小。 2016-12-30 第七次正式发布。本次变更如下: 在弹性伸缩组章节,增加“可用区”参数。 2016-11-28 第六次正式发布。本次变更如下: 新增生命周期挂钩。 新增错误码章节,新增AS.7030-AS.7043。 支持Cloudinit特性。 2016-10-29 第五次正式发布。本次变更如下: 修改创建弹性伸缩配置,增加metadata字段。 修改错误码章节,新增AS.7011、AS.1049、AS.1050和AS.1052 2016-09-18 第四次正式发布。本次变更说明如下: 修改查询伸缩组通知列表,新增“topic_name”字段说明。 2016-08-25 第三次正式发布。本次变更说明如下: 伸缩组支持绑定多个负载均衡监听器,修改文档中相应字段的参数说明。 修改错误码,新增AS.2037和AS.3034两条错误码。 新增通知章节。 2016-06-14 第二次正式发布。本次变更说明如下: 修改创建弹性伸缩组-修改弹性伸缩组中delete_publicip字段。 修改创建弹性伸缩配置-查询弹性伸缩配置详情中的public_ip字段、eip字段。 修改创建弹性伸缩配置“instance_config字段数据结构说明”,新增instance_id字段。 修改创建弹性伸缩配置“instance_config字段数据结构说明”,修改adminPass字段的密码规则。 修改查询弹性伸缩配置详情的响应示例。 2016-03-22 第一次正式发布。
  • 响应示例 { "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(选择优先)。