接口功能介绍
该接口供用户查询其所属专属宿主机列表。
接口约束
无
URI
POST /v4/dec/host/list
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | ef901a5734964ce29eedac918c4716a3 | |
| azName | 是 | String | 可用区名称。您可以调用资源池可用区查询获取可用区信息，查询结果中zoneList内返回存在可用区名称（即多可用区，本字段填写实际可用区名称），若查询结果中zoneList为空（即为单可用区，本字段填写default）。 | cn-huadong1-jsnj1A-public-ctcloud | |
| pageNo | 否 | Integer | 页码，取值范围：大于等于1，默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 ，取值范围:[1~50]，默认值为10，单页最大记录不超过50 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 专属宿主机列表信息 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目。 | 3 | |
| totalCount | Integer | 总记录数。 | 3 | |
| totalPage | Integer | 总页数。 | 1 | |
| results | Array of Objects | 分页明细，参考results对象结构。 | results |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| status | Boolean | 宿主机状态 | ||
| displayName | String | 展示给用户的宿主机名称 | ||
| cpuRatio | Double | CPU的倍频 | ||
| totalVM | Integer | 总的虚机数量 | 7 | |
| vcpuUsed | Integer | 已用vCPU的数量 | 50 | |
| memoryUsed | Integer | 已用内存大小，单位MB | 0 | |
| memory | Integer | 总内存大小，单位MB | 539182649344 | |
| cpu | Object | CPU信息 | cpu | |
| vcpu | Integer | vCPU的数量 | 50 | |
| autoDeployed | Boolean | 是否自动部署，取值范围： True表示自动部署， False表示非自动部署 |
||
| runningVM | Integer | 运行中的云主机数量 | 1 | |
| hostUUID | String | 宿主机UUID | ||
| name | String | 宿主机名称 |
表 cpu
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vendor | String | 制造商 | ||
| model | String | CPU模式 | ||
| arch | String | 架构 | ||
| featureList | Object | CPU特性，比如['pku','rtm'] 等 | featureList | |
| topology | Array of Objects | cpu拓扑结构 | topology |
表 topology
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| core | Integer | 核数 | 4 | |
| cell | Integer | cell数 | 4 | |
| thread | Integer | 线程数 | 4 | |
| socket | Integer | 套接字数 | 4 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "ef901a5734964ce29eedac918c4716a3",
"azName": "az1"
}
响应示例
{
"returnObj": {
"currentCount": 3,
"totalCount": 3,
"totalPage": 1,
"results": [
{
"status": "up",
"vcpuUsed": 50,
"displayName": "DCC-0002",
"name": null,
"hostUUID": "417cdb4b-de54-e5e5-62da-b78533a45b38",
"vcpu": 64,
"totalVM": 7,
"autoDeployed": true,
"memory": 539182649344,
"cpuRatio": 1,
"memoryUsed": 154618822656,
"cpu": null,
"runningVM": 1
},
{
"status": "up",
"vcpuUsed": 56,
"displayName": "DCC-0001c6",
"name": null,
"hostUUID": "96f01e15-4504-40d3-fe87-65f627cf340e",
"vcpu": 64,
"totalVM": 7,
"autoDeployed": true,
"memory": 539182645248,
"cpuRatio": 1,
"memoryUsed": 180388626432,
"cpu": null,
"runningVM": 0
},
{
"status": "up",
"vcpuUsed": 0,
"displayName": "DCC-0004--s6",
"name": null,
"hostUUID": "831ff89d-f409-ae6c-5c63-173b527b78f6",
"vcpu": 128,
"totalVM": 0,
"autoDeployed": true,
"memory": 539182649344,
"cpuRatio": 2,
"memoryUsed": 0,
"cpu": null,
"runningVM": 0
}
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
