接口功能介绍
该接口供用户查询其所属专属宿主机列表功能，用户可以根据此接口的返回值得到多台宿主机信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示50条数据
匹配查找：可以通过部分字段进行匹配筛选数据，无符合条件的为空
接口约束
无
URI
POST /v4/dec/host/list-host
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
| azName | 否 | String | 可用区名称，您可以查看地域和可用区来了解可用区 获取： 查 资源池可用区查询 注：查询结果中zoneList内返回存在可用区名称(即多可用区，本字段填写实际可用区名称)，若查询结果中zoneList为空（即为单可用区，本字段填写default） |
cn-huadong1-jsnj1A-public-ctcloud | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围：[1, 50]，注：默认值为10 | 10 | |
| keyword | 否 | String | 关键字，对部分参数进行模糊查询，包含：输入宿主机id、name信息 | name-x |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| decHostStatus | String | 宿主机状态 | up | |
| decHostName | String | 展示给用户的宿主机名称 | host-01 | |
| cpuRatio | Float | CPU的倍频 | 1 | |
| totalVMs | Integer | 总的虚机数量 | 2 | |
| usedVCPUs | Integer | 已用vCPU的数量 | 3 | |
| usedMemSize | Integer | 已用内存大小，单位MB | 154618822656 | |
| totalMemSize | Integer | 总内存大小，单位MB | 539182649344 | |
| totalVCPUs | Object | 总CPU数量 | ||
| autoDeployed | Boolean | 是否自动部署（True 自动部署，False 非自动部署） | true | |
| runningVMs | Integer | 运行中的云主机数量 | 2 | |
| decHostID | String | 宿主机UUID | 417cdb4b-de54-e5e5-62da-b78533a45b38 | |
| cpuInfo | Object | cpu信息 | cpuInfo |
表 cpuInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vendor | String | 制造商 | intel | |
| model | String | CPU模式 | ||
| arch | String | 架构 | x86 | |
| featureList | Object | CPU特性，比如["pku","rtm"]等 | ||
| topology | Object | cpu拓扑结构 | topology |
表 topology
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| cores | Integer | 核数 | 16 | |
| cells | Integer | cell数 | 2 | |
| threads | Integer | 线程数 | 2 | |
| sockets | Integer | 套接字数 | 2 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例1：指定每页记录数目，查询指定页宿主机信息
专属云内指定每页记录数目为3，查看第2页宿主机信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"pageNo": 2,
"pageSize": 3
}
示例2：在多可用区类型资源池，查看单个可用区下的宿主机信息
专属云内指定每页记录数目为5，查看第3页的宿主机信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"azName": "cn-huadong1-jsnj3A-public-ctcloud",
"pageNo": 3,
"pageSize": 5
}
示例3：指定关键字查找
专属云内查询关键字为test的云主机信息
{
"regionID": "a39b0db2989140c79e6de8c21d50f132",
"keyword": "test"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"decHostStatus": "up",
"decHostName": "DDC-0001",
"cpuRatio": 1,
"totalVMs": 2,
"usedVCPUs": 2,
"usedMemSize": 2048,
"totalMemSize": 514204,
"totalVCPUs": 64,
"autoDeployed": true,
"runningVMs": 1,
"decHostID": "197ffc44-eff9-be52-a5db-00df24acddec",
"cpuInfo": {
"vendor": null,
"model": null,
"arch": null,
"featureList": null,
"topology": {
"cores": 16,
"cells": null,
"threads": 2,
"sockets": null
}
}
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
