查询集群的专属宿主机配额

接口说明

本接口提供查询集群专属宿主机集群配额的功能,可以根据用户给定的专属宿主机集群ID,查询该集群下专属宿主机的配额信息。


推荐使用API Explorer调试

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

URL

POST https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/cluster/host/quota

请求参数

Body

参数名称
类型
必填
描述
dedicatedHostClusterIdsQueryReq
DedicatedHostClusterIdsQueryReq
是

查询集群的专属宿主机配额信息请求体

dedicatedHostClusterIds
<string> array
是

专属宿主机集群ID列表

region
string
是

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

请求示例

POST https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/cluster/host/quota
{
	"dedicatedHostClusterIds":[
		"id1"
	],
	"region":"region"
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
<DedicatedHostClusterQuotaDetailResp> array

专属宿主机集群配额详情返回结构体

dedicatedHostClusterId
string

专属宿主机集群ID

quantity
integer

配额最大值

quantityFrozen
integer

配额冻结值

remain
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":[
		{
			"dedicatedHostClusterId":"id1",
			"quantity":20,
			"quantityFrozen":10,
			"remain":10
		}
	],
	"requestId":"reqId1",
	"state":"OK"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。