查询专属宿主机列表
接口功能介绍
该接口供用户查询其所属专属宿主机列表。
接口约束
无
URI
POST /v4/dec/host/list-host
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以调用regionID查看最新的天翼云资源池列表 | ef901a5734964ce29eedac918c4716a3 | |
azName | 否 | String | 可用区名称,您可以调用获取资源池信息,查询结果中zoneList内返回存在可用区名称(即多可用区,本字段填写实际可用区名称),若查询结果中zoneList为空(即为单可用区,本字段填写default)。 | az2 | |
pageNo | 否 | Integer | 页码,取值范围:大于等于1,默认值为1 | 1 | |
pageSize | 否 | Integer | 每页记录数目,取值范围:[1~50],默认值为10,单页最大记录不超过50 | 10 | |
keyword | 否 | String | 查询关键字,输入宿主机id或name信息 | name-x |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
decHostStatus | Boolean | 宿主机状态 | 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数量 | 32 | |
usedVCPUs | Integer | 已用CPU的数量 | 8 | |
autoDeployed | Boolean | 是否自动部署(True 自动部署,False 非自动部署) | True | |
runningVMs | Integer | 运行中的云主机数量 | 2 | |
decHostID | Integer | 宿主机UUID | 417cdb4b-de54-e5e5-62da-b78533a45b38 | |
decHostName | String | 宿主机名称 | dec-host | |
cpuInfo | Object | cpu信息 | cpuInfo |
表 cpuInfo
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
vendor | String | 制造商 | intel | |
model | String | CPU模式 | ||
arch | String | 架构 | x86 | |
featureList | Object | CPU特性,比如["pku","rtm"]等 | pku | |
topology | Dict | cpu拓扑结构 | topology |
表 topology
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
cores | Integer | 核数 | 16 | |
cells | Integer | cell数 | 2 | |
threads | Integer | 线程数 | 2 | |
sockets | Integer | 套接字数 | 2 |
请求示例
请求体body
{
"regionID": "ef901a5734964ce29eedac918c4716a3",
"azName": "az2"
}
响应示例
{
"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
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功 |
错误码
errorCode | 描述 |
---|---|
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 | 查询专属云信息失败,请重试。如果多次尝试失败,请提交工单 |