查询可用于专属云的宿主机列表
接口功能介绍
该接口可供用户查询当前环境下哪些宿主机还可以加入用户所属的专属云
接口约束
无
URI
POST /v4/dec/host/available-list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | ef901a5734964ce29eedac918c4716a3 | |
azName | 是 | String | 可用区名称,您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | az2 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
currentCount | Integer | 当前页记录数目 | 1 | |
totalCount | Integer | 总记录数 | 1 | |
totalPage | Integer | 总页数 | 1 | |
results | Array of Objects | 分页明细 | results |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
azDisplayName | String | 展示给用户的可用区自定义名称(一般为空) | az-xx | |
decHostType | String | 宿主机类型 | cm6_optimized | |
hostName | String | 宿主机名称 | cn-nm-region1-az2-compute-10e8e92e46 |
请求示例
请求头header
无
请求体body
{
"regionID": "88f8888888dd88ec888888888d888d8b",
"azName": "az1"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"azDisplayName": "",
"decHostType": "cm6_optimized",
"hostName": "cn-nm-region1-az2-compute-10e8e92e46"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
错误码 | 描述 |
---|---|
Openapi.PatternCheck.NotValid | 请求参数无效 |
Dec.RegionInfo.Empty | 查询资源池信息为空或资源池不存在,请确认资源池ID是否有效 |
Dec.RegionInfo.AccessFailed | 查询资源池失败,请重试。如果多次尝试失败,请提交工单 |
Dec.RegionInfo.DataDamaged | 查询资源池信息不符预期,请重试。如果多次尝试失败,请提交工单 |
Dec.Parameter.InvalidAzName | 资源池中不存在该azName,请确认azName是否有效 |
Dec.Region.NotSupport | 当前资源池不支持专属云,请确认资源池ID是否有效 |
Openapi.DecWorkorder.AccessFailed | 查询专属云信息失败,请重试。如果多次尝试失败,请提交工单 |