接口说明
用于查看本资源池中已创建的专属宿主机集群列表。如果不指定可用区,将返回当前资源池所有可用区中的集群信息。
URL
GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/clusters
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
region
|
string
|
否
|
可用区,可通过查询属地的可用区信息获取。 |
|
page
|
integer(int32)
|
否
|
列表分页页数 |
|
size
|
integer(int32)
|
否
|
列表分页每页大小 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/clusters
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
分页查询统一返回结构体«专属宿主机集群列表项返回体»
|
请求成功时返回的数据 |
|
content
|
<专属宿主机集群列表项返回体> array
|
分页查询返回的具体结构体 |
|
allocationRatio
|
number(double)
|
该集群专属宿主机vCPU超分比 |
|
dedicatedHostClusterId
|
string
|
专属宿主机集群ID |
|
dedicatedHostClusterName
|
string
|
专属宿主机集群名称 |
|
dedicatedHostClusterType
|
string
|
该集群专属宿主机类型(例如common.s1) |
|
dedicatedHostProperties
|
<string,string> map
|
该集群专属宿主机规格配置 |
|
dedicatedhostNum
|
integer(int32)
|
专属宿主机服务器数量 |
|
region
|
string
|
专属宿主机集群所属AZ |
|
serverNum
|
integer(int32)
|
专属宿主机集群云主机数量 |
|
status
|
string
|
专属宿主机集群状态,AVAILABLE可用FROZEN冻结 |
|
totalCpuNum
|
integer(int32)
|
专属宿主机集群物理CPU核数总量 |
|
totalMemSize
|
integer(int64)
|
专属宿主机集群内存总量 |
|
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":0.0,
"dedicatedHostClusterId":"string",
"dedicatedHostClusterName":"string",
"dedicatedHostClusterType":"string",
"dedicatedHostProperties":{
"string":"string"
},
"dedicatedhostNum":0,
"region":"string",
"serverNum":0,
"status":"string",
"totalCpuNum":0,
"totalMemSize":0
}
],
"total":0
},
"errorCode":"string",
"errorMessage":"string",
"errorParams":[
"string"
],
"requestId":"string",
"state":"string"
}