查询弹性伸缩配置详情 - ShowScalingConfig
功能介绍
根据伸缩配置ID查询一个弹性伸缩配置的详细信息。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
as:scalingConfig:get
read
scalingConfig*
-
as:configs:get
-
URI
GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
scaling_configuration_id |
是 |
String |
伸缩配置ID,该ID对应全局唯一配置。可参考查询弹性伸缩配置详情 - ShowScalingConfig获取。 |
请求参数
无
请求示例
查询ID为6afe46f9-7d3d-4046-8748-3b2a1085ad86的伸缩配置详情。
GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86
响应消息
- 响应参数
表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
创建云服务器元数据,详情见表10。
security_groups
Array of security_groups objects
安全组信息。
server_group_id
String
云服务器组ID。
tenancy
String
在专属主机上创建弹性云服务器。
dedicated_host_id
String
专属主机的ID。
market_type
String
云服务器的计费模式。
取值范围:
- Null:按需计费
- spot:竞价计费
multi_flavor_priority_policy
String
使用伸缩配置创建云主机的时候,多规格使用的优先级策略。
表5 disk字段数据结构说明 参数
参数类型
描述
size
Integer
磁盘大小,容量单位为GB。
volume_type
String
磁盘类型,取值范围如下:
- SATA:普通IO云硬盘
- SAS:高IO云硬盘
- GPSSD:通用型SSD云硬盘
- SSD:超高IO云硬盘
- ESSD:极速IO云硬盘
- GPSSD2:通用型SSD V2云硬盘
- ESSD2:极速型SSD V2云硬盘
disk_type
String
系统盘还是数据盘,DATA表示为数据盘,SYS表示为系统盘。
dedicated_storage_id
String
磁盘所属的专属存储ID。
data_disk_image_id
String
导入数据盘的数据盘镜像ID。
snapshot_id
String
磁盘备份的快照ID。
metadata
metadata object
创建磁盘的元数据,详情见表10。
iops
Integer
云硬盘的iops。当“volume_type”设置为GPSSD2、ESSD2类型的云硬盘时,该参数可以设置。
说明:- 了解GPSSD2、ESSD2类型云硬盘的iops,请参见磁盘类型及性能介绍。
- 仅支持按需计费。
throughput
Integer
云硬盘的吞吐量,单位是MiB/s。当“volume_type”设置为GPSSD2类型的云硬盘时,该参数可以设置。
说明:- 了解GPSSD2类型云硬盘的吞吐量大小范围,请参见磁盘类型及性能介绍。
- 仅支持按需计费。
表8 eip字段数据结构说明 参数
参数类型
描述
ip_type
String
IP地址类型,类型枚举值如下:
- 5_bgp:全动态BGP
- 5_sbgp:静态BGP
详情请参见《虚拟私有云接口参考》“申请弹性公网IP”章节的“publicip”字段说明。
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字段数据结构说明 参数
参数类型
描述
__system__encrypted
String
metadata中的表示加密功能的字段,0代表不加密,1代表加密。
该字段不存在时,云硬盘默认为不加密。
__system__cmkid
String
用户主密钥ID,是metadata中的表示加密功能的字段,与__system__encrypted配合使用。
说明:请参考查询密钥列表,通过HTTPS请求获取密钥ID。
响应示例
{
"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"
}
}
返回值
- 正常
- 异常
返回值
说明
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
网关超时。
错误码
请参考错误码。