# 查询超节点组可售情况-ListHyperGroupCapacityEvaluation #### 功能介绍 在超节点组中需要进行超节点扩容时，通过指定超节点组ID和规格列表查询对应超节点是否还有容量可供创建。注意如果超节点组内没有超节点，请使用capacity-evaluation查询。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AICS/doc?api=ListHyperGroupCapacityEvaluation)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-aics/aics_05_0700.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | aics::listHyperGroupCapacityEvaluation | List | - | - | - | - | #### URI GET /v2/{project_id}/hyper-group-capacity-evaluation 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-aics/aics_api_0702.html)。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释**: 分页标记，本次请求获取该标记后的资源，base64编码。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | | limit | 否 | Integer | **参数解释**: 分页查询单页记录数量。 **约束限制**: 不涉及。 **取值范围**: 1-10。 **默认取值**: 10。 | | hypernode_types | 是 | Array of strings | **参数解释**: 超节点规格列表，用于筛选指定规格的可售情况。可从查询超节点类型列表接口获取。 **约束限制**: 最多10个规格，多个规格以逗号分隔。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 **默认取值**: 不涉及。 | | hyper_group_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}。 **默认取值**: 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释**: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | hyper_group_capacity_evaluations | Array of [HyperGroupCapacityEvaluation] objects | **参数解释**: 超节点组容量评估列表。 **取值范围**: 不涉及。 | | page_info | [PageInfo] object | **参数解释**: 分页信息。 **取值范围**: 不涉及。 | 表5HyperGroupCapacityEvaluation | 参数 | 参数类型 | 描述 | |:---|:---|:---| | availability_zone_id | String | **参数解释**: 可用区ID。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 | | hypernode_type | String | **参数解释**: 超节点规格。可从查询超节点类型列表接口获取。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 | | hyper_group_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}。 | | 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 | **参数解释**: 是否可购买。 **取值范围**: - true：可购买。 - false：已售罄。 | 表6PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释**: 以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。 **取值范围**: 不涉及。 | | current_count | Integer | **参数解释** : 当前查询结果数量。 **取值范围** : 不涉及。 | #### 请求示例 查询超节点组可售情况请求示例。使用场景：用户需要查询指定超节点组下超节点规格的可售情况进行扩容时，通过指定超节点组ID和规格列表查询。 ``` GET https://{endpoint}/v2/{project_id}/hyper-group-capacity-evaluation?hyper_group_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890&hypernode_types=kat3ne-8.48xlarge.8.800t.matrix ``` #### 响应示例 **状态码：200** OK ``` { "hyper_group_capacity_evaluations" : [ { "availability_zone_id" : "cn-east-3a", "hypernode_type" : "kat3ne-8.48xlarge.8.800t.matrix", "hyper_group_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "cluster_id" : "b2c3d4e5-f6a7-8901-bcde-f12345678901", "is_available" : true } ], "page_info" : { "next_marker" : null, "current_count" : 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-aics/ErrorCode.html)。