# 查询Hyper Cluster详情列表 - ListHyperCluster
#### 功能介绍
查询Hyper Cluster详情列表接口用于获取所有Hyper Cluster的详细信息。该接口适用于以下场景：当用户需要了解系统中所有超节点网络的配置和状态时，可以通过此接口获取相关信息。使用该接口的前提条件是用户已登录并具有查询Hyper Cluster详情的权限。查询操作完成后，接口将返回所有超节点网络的详细信息，包括ID、名称、子网信息等。若用户无权限操作或系统中没有Hyper Cluster，接口将返回相应的错误信息。
#### 接口约束
暂无约束。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListHyperCluster)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
GET /v1/{project_id}/dev-servers/hyper-clusters
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释**：用户项目ID。 **约束限制**：必填。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 |
   
表2Query参数 
| 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| type | 否    | String | **参数解释**：Hyper Cluster的类型。 **约束限制**：可选。 **取值范围**： - HPS：默认值，查询HPS机型的Hyper Cluster。   - ECS：查询ECS机型的Hyper Cluster。    **默认取值**：HPS。 |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数             | 参数类型                                                                                                               | 描述                        |
|:---|:---|:---|
| hyper_clusters | Array of [HyperCluster] objects | **参数解释**：Hyper Cluster列表。 |
   
 表4HyperCluster 
| 参数           | 参数类型                                                                                                               | 描述                                                                                                                                                                                                         |
|:---|:---|:---|
| id           | String                                                                                                             | **参数解释**：hyper cluster的ID。 **取值范围**：\^\[0-9a-f\]{8}-\[0-9a-f\]{4}-\[1-5\]\[0-9a-f\]{3}-\[89ab\]\[0-9a-f\]{3}-\[0-9a-f\]{12}$。 |
| name         | String                                                                                                             | **参数解释**：hyper cluster的名称。 **取值范围**：\^\[-_.a-zA-Z0-9\]{1,64}$。                                                                |
| network_info | Array of [network_info] objects | **参数解释**：网络信息。                                                                                                                                                                                             |
   
 表5network_info 
| 参数                      | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| hyper_cluster_subnet_id | String  | **参数解释**：hyper cluster的子网名称。 **取值范围**：\^\[-_.a-zA-Z0-9\]{1,64}$。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| is_default              | Boolean | **参数解释**：是否默认。 **取值范围**： - true：默认网络   - false：非默认网络    |
   
#### 请求示例
```
GET https://{endpoint}/v1/{project_id}/dev-servers/hyper-clusters
```
#### 响应示例
**状态码：200**
```
{
  "hyper_clusters" : [ {
    "id" : "e05f463f-b8d0-4377-bb48-a72c67432590",
    "name" : "kat3ned-8-752t.80xlarge.8.matrix-6e35",
    "network_info" : [ {
      "hyper_cluster_subnet_id" : "a7f3607c-4d7d-4bd0-b922-5a8f1e3a4f48",
      "is_default" : true
    } ]
  }, {
    "id" : "c9292bec-40eb-4cac-94ea-d7ce0b7941a5",
    "name" : "test-kat3ne-8.48xlarge.8.800t.matrix",
    "network_info" : [ {
      "hyper_cluster_subnet_id" : "730a875a-2f98-4d4f-b93e-11ae072173d7",
      "is_default" : true
    } ]
  } ]
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。