查询弹性伸缩配置列表 - ListScalingConfigs
功能介绍
根据输入条件过滤查询弹性伸缩配置。查询结果分页显示。
- 可以根据伸缩配置名称,镜像ID,起始行号,记录条数进行条件过滤查询。
- 若不加过滤条件默认最多查询租户下20条伸缩配置信息。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
as:scalingConfig:list
list
scalingConfig*
-
as:configs:list
-
URI
GET /autoscaling-api/v1/{project_id}/scaling_configuration
可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求示例。
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| scaling_configuration_name | 否 | String | 参数解释: 伸缩配置名称。 约束限制: 不涉及 取值范围: 1-64个字符,只能包含中文、字母、数字、下划线或中划线。 默认取值: 不涉及 |
| image_id | 否 | String | 参数解释: 镜像ID,同imageRef,指定创建实例时选择的镜像资源。通过查询镜像服务镜像列表接口获取,详情请参考查询镜像列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_number | 否 | Integer | 参数解释: 查询的起始行号。 约束限制: 不涉及 取值范围: 最小值为0。 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 查询的记录条数。 约束限制: 不涉及 取值范围: 0-100 默认取值: 20 |
请求参数
无
请求示例
查询使用了镜像ID为37ca2b35-6fc7-47ab-93c7-900324809c5c的伸缩配置。
GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c 响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_number | Integer | 参数解释: 总记录数。 取值范围: 不涉及 |
| start_number | Integer | 参数解释: 查询的起始行号。 取值范围: 最小值为0。 |
| limit | Integer | 参数解释: 查询记录数。 取值范围: 0-100 |
| scaling_configurations | Array of scaling_configurations objects | 参数解释: 伸缩配置列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| scaling_configuration_id | String | 参数解释: 伸缩配置ID,全局唯一。 取值范围: 不涉及 |
| tenant | String | 参数解释: 租户ID。 取值范围: 不涉及 |
| scaling_configuration_name | String | 参数解释: 伸缩配置名称。支持模糊匹配。 取值范围: 1-64个字符,只能包含中文、字母、数字、下划线或中划线。 |
| instance_config | instance_config object | 参数解释: 实例配置信息。 |
| create_time | String | 参数解释: 创建伸缩配置时间,遵循UTC时间。格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-05-10T10:00:00Z。 取值范围: 不涉及 |
| scaling_group_id | String | 参数解释: 绑定该伸缩配置的伸缩组ID。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 实例ID,该参数为预留字段。 取值范围: 不涉及 |
| 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 | 参数解释: 使用伸缩配置创建云主机的时候,多规格使用的优先级策略。 取值范围:
|
| cpu_options | CpuOptions object | 参数解释: 表示是否关闭实例超线程。详情请见表13 cpu_options字段数据结构说明。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| size | Integer | 参数解释: 磁盘大小,容量单位为GB。 取值范围:
|
| volume_type | String | 参数解释: 磁盘类型。 取值范围:
|
| disk_type | String | 参数解释: 磁盘类型,系统盘或数据盘。 取值范围:
|
| 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类型的云硬盘时,该参数可以设置。 说明:
取值范围:
|
| throughput | Integer | 参数解释: 云硬盘的吞吐量,单位是MiB/s。当“volume_type”设置为GPSSD2类型的云硬盘时,该参数可以设置。 说明:
取值范围: 125-1000 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| __system__encrypted | String | 参数解释: metadata中的表示加密功能的字段。 该字段不存在时,云硬盘默认为不加密。 取值范围: 0:代表不加密 1:代表加密。 |
| __system__cmkid | String | 参数解释: 用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。 说明: 请参考查询密钥列表,通过HTTPS请求获取密钥ID。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| path | String | 参数解释: 注入文件路径信息。 取值范围:
|
| content | String | 参数解释: 注入文件内容,base64格式编码。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| ip_type | String | 参数解释: IP地址类型。 详情请参见《虚拟私有云接口参考》“申请弹性公网IP”章节的“publicip”字段说明。 取值范围:
|
| bandwidth | bandwidth object | 参数解释: IP地址带宽参数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| size | Integer | 参数解释: 带宽(Mbit/s)。 取值范围: 带宽(Mbit/s),按带宽分配取值范围为[1,2000],按流量分配取值范围为[1,300]。 |
| share_type | String | 参数解释: 带宽的共享类型。 取值范围:
|
| charging_mode | String | 参数解释: 带宽的计费类型。 取值范围:
|
| id | String | 参数解释: 带宽ID,创建WHOLE类型带宽的弹性IP时指定的共享带宽。 取值范围: 不涉及 |
响应示例
{
"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"
},
{
"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"
}],
"cpu_options" : 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"
}
]
} 返回值
- 正常
- 异常
返回值
说明
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
网关超时。
错误码
请参考错误码。