# 查询超节点hyperinstance-clusters逻辑容量测算结果 - ListHyperinstanceClustersCapacity
#### 功能介绍
查询超节点hyperinstance-clusters逻辑容量测算结果接口用于获取指定超节点集群的逻辑容量测算结果。该接口适用于以下场景：当用户需要了解超节点集群的资源使用情况和容量规划，以便进行资源管理和优化时，可以通过此接口获取逻辑容量测算结果。使用该接口的前提条件是用户已登录并具有查询超节点集群逻辑容量的权限，且指定的超节点集群已存在。查询操作完成后，接口将返回指定超节点集群的逻辑容量测算结果，包括可用容量信息。若用户无权限操作、指定的超节点集群不存在或集群ID无效，接口将返回相应的错误信息。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListHyperinstanceClustersCapacity)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
POST /v1/{project_id}/dev-servers/hyperinstance/cluster-capacity-evaluations
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1\~64个字符，只能由字母、数字和中划线组成。 **默认取值**：不涉及。 |
   
#### 请求参数
表2请求Body参数 
| 参数                        | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| hyperinstance_cluster_ids | 否    | Array of strings | **参数解释**：超节点集群ID列表。 **约束限制**：数组长度0-5，每个元素长度1-128字符。 **默认取值**：不涉及。 |
| flavor                    | 否    | String           | **参数解释**：规格名称。 **约束限制**：长度1-65536个字符。 **默认取值**：不涉及。               |
| availability_zone         | 否    | String           | **参数解释**：可用区。 **约束限制**：长度1-65536个字符。 **默认取值**：不涉及。                |
| resource_flavor           | 否    | String           | **参数解释**：资源规格。 **约束限制**：长度1-65536个字符。 **默认取值**：不涉及。               |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                                                                                                       | 描述     |
|:---|:---|:---|
| capacities | Array of [ServerHpsClusterCapacity] objects | 容量信息列表 |
   
 表4ServerHpsClusterCapacity 
| 参数                         | 参数类型    | 描述                |
|:---|:---|:---|
| flavor                     | String  | **参数解释**：规格名称。    |
| availability_zone          | String  | **参数解释**：可用区ID。   |
| hyperinstance_cluster_id   | String  | **参数解释**：超节点集群ID。 |
| hyperinstance_cluster_name | String  | **参数解释**：超节点集群名称。 |
| resource_flavor            | String  | **参数解释**：资源规格。    |
| is_sold_out                | Boolean | **参数解释**：售罄状态。    |
   
**状态码：401**
表5响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                |
|:---|:---|:---|
| error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 |
| error_msg  | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。       |
   
**状态码：403**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                |
|:---|:---|:---|
| error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 |
| error_msg  | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。       |
   
**状态码：404**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                |
|:---|:---|:---|
| error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 |
| error_msg  | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。       |
   
#### 请求示例
```
POST https://{endpoint}/v1/{project_id}/dev-servers/hyperinstance/cluster-capacity-evaluations
{
  "hyperinstance_cluster_ids" : [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ],
  "flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
  "availability_zone" : "cn-east-3a",
  "resource_flavor" : "gpu.8xlarge"
}
```
#### 响应示例
**状态码：200**
```
{
  "capacities" : [ {
    "flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
    "availability_zone" : "cn-east-3a",
    "hyperinstance_cluster_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "hyperinstance_cluster_name" : "production-cluster-1",
    "resource_flavor" : "gpu.8xlarge",
    "is_sold_out" : true
  }, {
    "flavor" : "kat3ne-16.96xlarge.16.1600t.matrix",
    "availability_zone" : "cn-east-3b",
    "hyperinstance_cluster_id" : "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "hyperinstance_cluster_name" : "production-cluster-2",
    "resource_flavor" : "gpu.16xlarge",
    "is_sold_out" : true
  } ]
}
```
#### 状态码
| 状态码 | 描述               |
|:---|:---|
| 200 | **参数解释**：容量查询结果。 |
| 401 | Unauthorized     |
| 403 | Forbidden        |
| 404 | Not Found        |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。