接口功能介绍
该接口可供用户查询当前环境下哪些宿主机还可以加入用户所属的专属云
接口约束
无
URI
POST /v4/dec/host/available-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以调用资源池列表查询查看最新a的天翼云资源池列表 | bb9fdb42056f11eda161024aac110002 | |
| azName | 是 | String | 可用区名称。您可以调用资源池可用区查询获取可用区信息，查询结果中zoneList内返回存在可用区名称（即多可用区，本字段填写实际可用区名称），若查询结果中zoneList为空（即为单可用区，本字段填写default）。 | cn-huadong1-jsnj1A-public-ctcloud |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 可用于专属云的宿主机列表信息 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目。 | 1 | |
| totalCount | Integer | 总记录数。 | 1 | |
| totalPage | Integer | 总页数。 | 0 | |
| results | Array of Objects | 分页明细 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| azDisplayName | String | 展示给用户的可用区自定义名称（一般为空） | ||
| decHostType | String | 宿主机类型 | ||
| hostName | String | 宿主机名称 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "bb9fdb42056f11eda161024aac110002",
"azName": "cn-huadong1-jsnj1A-public-ctcloud"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": null,
"results": [{
"azDisplayName": "",
"decHostType": "cm6_optimized",
"hostName": "cn-nm-region1-az2-compute-10e8e92e46"
}]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
