查询弹性伸缩配置
接口功能介绍
查询弹性伸缩配置
接口约束
无
URI
POST /v4/scaling/config-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
configID | 否 | Integer | 伸缩配置ID | 427 | |
pageNo | 否 | Integer | 页码 | 5 | |
page | 否 | Integer | 【Deprecated】页码 | 5 | |
pageSize | 否 | Integer | 分页查询时设置的每页行数,取值范围:[1~100],默认值为10 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回码:800表示成功,900表示失败 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码 | Scaling.Config.NotFound | 错误码 |
message | String | 失败时的错误描述,一般为英文描述 | query scaling config empty | |
description | String | 失败时的错误描述,一般为中文描述 | 未找到弹性伸缩配置信息 | |
returnObj | Array of Objects | 成功时返回的数据,参见表returnObj | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
configID | Integer | 伸缩配置ID | 427 | |
name | String | 伸缩配置名称 | as-config-local001 | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
visibility | Integer | 镜像类型。取值范围: 1:公有镜像0:私有镜像 | 1 | |
imageName | String | 镜像名称 | CentOS7.5 | |
imageID | String | 镜像ID | b78812b0-ff50-4816-b58f-5c4fbc230b08 | |
securityGroupList | Array of Objects | 安全组ID | [{"id": "sg-nd1h63d2j8", "name": "Default-Security-Group"}] | |
cpu | Integer | CPU核数 | 2 | |
memory | Integer | 内存,单位:G | 4 | |
specName | String | 规格名称 | c6.large.2 | |
osType | Integer | 镜像系统类型。取值范围:1:Linux2:Windows | 1 | |
volumes | Array of Objects | 磁盘类型和大小列表,元素为volume | [{"volumeType":"SATA", "volumeSize":40,"flag":1}] | volume |
useFloatings | Integer | 是否使用弹性IP。 取值范围:1:不使用。2:自动分配。 | 2 | |
bandwidth | Integer | 带宽,单位:Mbps | 100 | |
loginMode | Integer | 登录方式。取值范围:1:密码。2:密钥对 | 2 | |
username | String | 用户名,loginMode为1时,必填 | root | |
groupCount | Integer | 绑定的伸缩组个数 | 0 | |
userData | String | 用户自定义数据,以Base64方式编码 | ZWNobyBoZWxsbyBnb3N0YWNrIQ== | |
tags | Array of Objects | 标签集 | tag | |
azNames | String | 可用区名称 | az1 | |
monitorService | Boolean | 是否开启详细监控,默认开启。 取值范围:true:开启。false:关闭 | true |
表 volume
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
volumeType | String | 磁盘类型: SATA/SAS/SSD/SATA-KUNPENG/SATA-HAIGUANG/SAS-KUNPENG/SAS-HAIGUANG/SSD-genric。不同资源池可配置的volumeType有差异,详细请参考云硬盘 | SATA | |
volumeSize | Integer | 磁盘大小 | 40 | |
flag | Integer | 磁盘类型。取值范围:1:系统盘。2:数据盘。系统盘限制为1块。 | 1 |
表tag
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
key | String | 标签键 | key1 | |
value | String | 标签值 | value1 |
请求示例
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"configID": 427
}
响应示例
{
"returnObj": [
{
"imageID": "b78812b0-ff50-4816-b58f-5c4fbc230b08",
"bandwidth": 1,
"osType": 1,
"securityGroupList": [],
"configID": 427,
"regionID": "81f7728662dd11ec810800155d307d5b",
"imageName": "CentOS7.5",
"memory": 1,
"specName": "s2.small.1",
"useFloatings": 1,
"username": "root",
"groupCount": 0,
"visibility": 1,
"name": "zjy-config-test",
"loginMode": 2,
"userData": "ZWNobyBoZWxsbyBnb3N0YWNrIQ==",
"volumes": [
{
"volumeType": "SATA",
"volumeSize": 40,
"flag": 1
}
],
"cpu": 1,
"tags": [
{
"key": "k0",
"value": "v0"
}
],
"azNames": "az1"
}
],
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
errorCode | 描述 |
---|---|
Scaling.Config.NotFound | 未找到弹性伸缩配置信息 |
Scaling.Parameter.InvalidError | 请求参数错误 |