查询集群可售情况-ListClusterCapacityEvaluation
功能介绍
在集群中需要进行超节点扩容时,用户可通过指定集群ID和规格列表查询对应的超节点是否还有容量可供创建。注意如果集群内没有超节点,请使用capacity-evaluation查询。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics::listClusterCapacityEvaluation | List | - | - | - | - |
URI
GET /v2/{project_id}/cluster-capacity-evaluation
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| marker | 否 | String | 参数解释: 分页标记,本次请求获取该标记后的资源,base64编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 分页查询单页记录数量。 约束限制: 不涉及。 取值范围: 1-10。 默认取值: 10。 |
| hypernode_types | 是 | Array of strings | 参数解释: 超节点规格列表,用于筛选指定规格的可售情况。可从查询超节点类型列表接口获取。 约束限制: 最多10个规格,多个规格以逗号分隔。 取值范围: 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 默认取值: 不涉及。 |
| cluster_id | 是 | String | 参数解释: 集群ID,用于筛选指定集群的可售情况。可从查询集群列表接口获取。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cluster_capacity_evaluations | Array of ClusterCapacityEvaluation objects | 参数解释: 集群容量评估列表。 取值范围: 不涉及。 |
| page_info | PageInfo object | 参数解释: 分页信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| availability_zone_id | String | 参数解释: 可用区ID。 取值范围: 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 |
| hypernode_type | String | 参数解释: 超节点规格。可从查询超节点类型列表接口获取。 取值范围: 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 |
| cluster_id | String | 参数解释: 集群ID。可从查询集群列表接口获取。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
| is_available | Boolean | 参数解释: 是否可购买。 取值范围: |
请求示例
查询集群可售情况请求示例。使用场景:用户需要查询指定集群下超节点规格的可售情况进行扩容时,通过指定集群ID和规格列表查询。
GET https://{endpoint}/v2/{project_id}/cluster-capacity-evaluation?cluster_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890&hypernode_types=kat3ne-8.48xlarge.8.800t.matrix 响应示例
状态码:200
OK
{
"cluster_capacity_evaluations" : [ {
"availability_zone_id" : "cn-east-3a",
"hypernode_type" : "kat3ne-8.48xlarge.8.800t.matrix",
"cluster_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"is_available" : true
} ],
"page_info" : {
"next_marker" : null,
"current_count" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。