5.2 弹性伸缩配置
5.2.2 查询弹性伸缩配置列表
功能介绍
根据输入条件过滤查询弹性伸缩配置。查询结果分页显示。
● 可以根据伸缩配置名称，镜像ID，起始行号，记录条数进行条件过滤查询。
● 若不加过滤条件默认最多查询租户下20条伸缩配置信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /autoscaling-api/v1/{project_id}/scaling_configuration 说明
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过 滤，请参考请求样例。
表5-46 参数说明
参数 是否必选 参数类型 描述
project_id 是 String 项目ID。
scaling_configuration_na
me 否 String 伸缩配置名称。
支持模糊匹配。
image_id 否 String 镜像ID，同imageRef。
start_number 否 Integer 查询的起始行号，默认为0。
最小值为0。
limit 否 Integer 查询的记录条数，默认为
20。取值范围为：0~100。
请求消息
● 请求参数 无
● 请求样例
本示例展示了查询使用了ID为37ca2b35-6fc7-47ab-93c7-900324809c5c的镜像的 伸缩配置。
GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?
image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c
响应消息
● 响应参数
表5-47 响应参数
参数 参数类型 描述
total_number Integer 总记录数。
start_number Integer 查询的起始行号。
limit Integer 查询记录数。
scaling_configurati
ons Array of
scaling_configurations objects
伸缩配置列表。
表5-48 scaling_configurations 字段数据结构说明
参数 参数类型 描述
scaling_configurati
on_id String 伸缩配置ID，全局唯一。
tenant String 租户ID。
scaling_configurati
on_name String 伸缩配置名称。
支持模糊匹配。
instance_config instance_config
object 实例配置信息。
create_time String 创建伸缩配置时间，遵循UTC时间。
scaling_group_id String 绑定该伸缩配置的伸缩组ID。
表5-49 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_id String 该参数为预留字段。
adminPass String 该参数为预留字段。
personality Array of personality objects
注入文件信息。
public_ip public_ip object 云服务器的弹性IP信息。
user_data String cloud-init用户数据，base64格式编 码。
metadata metadata object 创建云服务器元数据，详情见表 5-56。
security_groups Array of
security_groups objects
安全组信息。
server_group_id String 云服务器组ID。
tenancy String 在专属主机上创建弹性云服务器。
dedicated_host_id String 专属主机的ID。
market_type String 云服务器的计费模式，可以选择竞价 计费或按需计费。
multi_flavor_priorit
y_policy String 使用伸缩配置创建云主机的时候，多 规格使用的优先级策略。
。
表5-50 disk 字段数据结构说明
参数 参数类型 描述
size Integer 磁盘大小，容量单位为GB。
volume_type String 磁盘类型。
disk_type String 系统盘还是数据盘，DATA表示为数 据盘，SYS表示为系统盘。
dedicated_storage_
id String 磁盘所属的专属存储ID。
data_disk_image_i
d String 导入数据盘的数据盘镜像ID。
snapshot_id String 磁盘备份的快照ID。
metadata metadata object 创建磁盘的元数据，详情见表 5-51。
表5-51 创建磁盘的 metadata 字段数据结构说明
参数 参数类型 描述
__system__encrypte
d String metadata中的表示加密功能的字
段，0代表不加密，1代表加密。
该字段不存在时，云硬盘默认为不 加密。
__system__cmkid String 用户主密钥ID，是metadata中的表 示加密功能的字段，与
__system__encrypted配合使用。
说明请参考查询密钥列表，通过HTTPS请求 获取密钥ID。
表5-52 personality 字段数据结构说明
参数 参数类型 描述
path String 注入文件路径信息。
content String 注入文件内容，base64格式编码。
表5-53 public_ip 字段数据结构说明
参数 参数类型 描述
eip eip object 云服务器自动分配弹性IP时，创建
弹性IP的配置参数。
表5-54 eip 字段数据结构说明
参数 参数类型 描述
ip_type String IP地址类型。
bandwidth bandwidth
object IP地址带宽参数。
表5-55 bandwidth 字段数据结构说明
参数 参数类型 描述
size Integer 带宽（Mbit/s）。
参数 参数类型 描述
share_type String 带宽的共享类型。
共享类型枚举：
● PER：独享型。
● WHOLE：共享型。
charging_mode String 带宽的计费类型。
● bandwidth：按带宽计费。
● traffic：按流量计费。
id String 带宽ID，创建WHOLE类型带宽的弹
性IP时指定的共享带宽。
表5-56 metadata 字段数据结构说明
参数 参数类型 描述
admin_pass String Windows弹性云服务器 Administrator用户的密码。
表5-57 security_groups 字段数据结构说明
参数 参数类型 描述
id String 安全组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": {
"imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c",
"tenant": "ce061903a53545dcaddb300093b477d2",
"scaling_configuration_id": "24a8c5f3-c713-4aba-ac29-c17101009e5d", "scaling_configuration_name": "config_name_2",
"instance_config": {
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 网关超时。
错误码
请参考错误码。