接口功能介绍
该接口可供用户查询当前环境下，用户所属的专属云下还可以加入的宿主机的信息列表
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
接口约束
无
URI
GET /v4/dec/host/list-available-host
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用区名称，您可以查看地域和可用区来了解可用区 获取： 查 资源池可用区查询 注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default） |
cn-huadong1-jsnj1A-public-ctcloud |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
| error | 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 |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| azName | String | 展示给用户的可用区自定义名称（一般为空） | az2 | |
| decHostType | String | 宿主机类型，取值范围：s2、c6、s6、s7、c7、s3、c3，类型会随着专属云能力进行增加 | cm6_optimized | |
| decHostName | String | 宿主机名称 | cn-nm-region1-az2-compute-10e8e92e46 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例：查询专属云资源池内可加入的宿主机信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"azName": "",
"decHostType": "cm6_optimized",
"decHostName": "cn-nm-region1-az2-compute-10e8e92e46"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
