查看专属宿主机集群详情

接口说明


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/clusters/{dedicatedHostClusterId}

请求参数

Path

参数名称
类型
必填
描述
dedicatedHostClusterId
string
是

专属宿主机集群ID

Query

参数名称
类型
必填
描述
region
string
是

可用区,可通过查询属地的可用区信息获取。

请求示例

GET https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/clusters/{dedicatedHostClusterId}

返回参数

返回码:200
OK
参数名称
类型
描述
body
专属宿主机集群详情返回体

请求成功时返回的数据。

allocationRatio
number(double)

该集群专属宿主机vCPU超分比

dedicatedHostClusterId
string

专属宿主机集群ID

dedicatedHostClusterName
string

专属宿主机集群名称

dedicatedHostClusterType
string

专属宿主机集群类型,如s1

dedicatedHostProperties
<string,string> map

专属宿主机规格配置

dedicatedhostNum
integer(int32)

专属宿主机服务器数量

description
string

描述信息

openHa
boolean

是否开启了高可用功能

region
string

可用区

totalCpuNum
integer(int32)

专属宿主机集群vCPU核数总量

totalMemSize
integer(int64)

专属宿主机集群内存总量

totalVGpuNum
integer(int32)

专属宿主机集群vGPU总量

usedCpuNum
integer(int32)

专属宿主机集群vCPU核数已使用量

usedMemSize
integer(int64)

专属宿主机集群内存已使用量

usedVGpuNum
integer(int32)

专属宿主机集群vGPU已使用量

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"body":{
		"allocationRatio":"",
		"dedicatedHostClusterId":"",
		"dedicatedHostClusterName":"",
		"dedicatedHostClusterType":"",
		"dedicatedHostProperties":"",
		"dedicatedhostNum":"",
		"description":"",
		"openHa":"false",
		"region":"",
		"totalCpuNum":"",
		"totalMemSize":"",
		"totalVGpuNum":"",
		"usedCpuNum":"",
		"usedMemSize":"",
		"usedVGpuNum":""
	},
	"errorCode":"",
	"errorMessage":"",
	"errorParams":[
		""
	],
	"requestId":"",
	"state":""
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。