接口说明
本接口用于查看指定集群内所有的专属宿主机信息。
URL
GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/clusters/{dedicatedHostClusterId}/dedicatedHosts
请求参数
Path
|
参数名称
|
类型
|
必填
|
描述
|
|
dedicatedHostClusterId
|
string
|
是
|
专属宿主机集群ID |
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
region
|
string
|
是
|
可用区，可通过查询属地的可用区信息获取。 |
|
page
|
integer(int32)
|
否
|
列表分页页数 |
|
size
|
integer(int32)
|
否
|
列表分页每页大小 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/clusters/{dedicatedHostClusterId}/dedicatedHosts返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
分页查询统一返回结构体«专属宿主机列表信息»
|
请求成功时返回的数据 |
|
content
|
<专属宿主机列表信息> array
|
分页查询返回的具体结构体 |
|
allocationRatio
|
number(double)
|
专属宿主机vCPU超分比 |
|
createdTime
|
string(date-time)
|
专属宿主机创建时间 |
|
dedicatedHostId
|
string
|
专属宿主机ID |
|
dedicatedHostName
|
string
|
专属宿主机名称 |
|
modifiedTime
|
string(date-time)
|
专属宿主机修改时间 |
|
region
|
string
|
专属宿主机集群所属AZ |
|
state
|
string
|
专属宿主机运行状态 |
|
status
|
string
|
专属宿主机是否启用状态 |
|
totalCpuNum
|
integer(int32)
|
专属宿主机vCPU核数总量 |
|
totalMemSize
|
integer(int32)
|
专属宿主机内存总量 |
|
totalVGpuNum
|
integer(int32)
|
专属宿主机vGPU总量 |
|
usedCpuNum
|
integer(int32)
|
专属宿主机已使用的vCPU核数 |
|
usedMemSize
|
integer(int64)
|
专属宿主机内存已使用量 |
|
usedVGpuNum
|
integer(int32)
|
专属宿主机vGPU已使用量 |
|
dedicatedHostClusterId
|
string
|
专属宿主机集群ID |
|
total
|
integer
|
满足查询条件的总个数 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码，返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN |
返回示例
返回码：200
OK
{
"body":{
"content":[
{
"allocationRatio":"",
"dedicatedHostId":"",
"dedicatedHostName":"",
"region":"",
"state":"UP/DOWN",
"status":"ENABLED/DISABLED",
"totalCpuNum":"",
"totalMemSize":"",
"totalVGpuNum":"",
"usedCpuNum":"",
"usedMemSize":"",
"usedVGpuNum":"",
"createdTime":"2025-05-29 15:36:20",
"modifiedTime":"2025-05-29 17:00:00"
}
],
"dedicatedHostClusterId":"",
"total":""
},
"errorCode":"",
"errorMessage":"",
"errorParams":[
""
],
"requestId":"",
"state":""
}