# 列举超节点信息-ListHypernodes
#### 功能介绍
获取该用户项目下所有的超节点信息。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AICS/doc?api=ListHypernodes)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-aics/aics_05_0700.html)。
| 授权项                 | 访问级别 | 资源类型（\*为必须）  | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| aics:hypernode:list | List | hypernode \* | -   | -  | -      |
   
#### URI
GET /v2/{project_id}/hypernodes
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释**: 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-aics/aics_api_0702.html)。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 |
   
表2Query参数 
| 参数             | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| cluster_id     | 否    | String  | **参数解释**: 集群唯一标识UUID。 **约束限制**: 不涉及。 **取值范围**: 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}。 **默认取值**: 不涉及。   |
| hyper_group_id | 否    | String  | **参数解释**: 超节点组唯一标识UUID。 **约束限制**: 不涉及。 **取值范围**: 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}。 **默认取值**: 不涉及。 |
| hypernode_type | 否    | String  | **参数解释**: 超节点规格。 **约束限制**: 不涉及。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 **默认取值**: 不涉及。                                                                     |
| name           | 否    | String  | **参数解释**: 超节点名称。 **约束限制**: 不涉及。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 **默认取值**: 不涉及。                                                                     |
| limit          | 否    | Integer | **参数解释**: 分页查询单页记录数量。 **约束限制**: 不涉及。 **取值范围**: 1\~100。 **默认取值**: 20。                                                                                          |
| marker         | 否    | String  | **参数解释**: 分页标记，本次请求获取该标记后的资源，base64编码。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。                                                                           |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | **参数解释**: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数         | 参数类型                                                                                      | 描述                                                                                                                                    |
|:---|:---|:---|
| hypernodes | Array of [HypernodeResponseBody] objects | **参数解释**: 超节点列表。 **取值范围**: 不涉及。 |
| page_info  | [PageInfo] object                                     | **参数解释**: 分页信息。 **取值范围**: 不涉及。  |
   
 表5HypernodeResponseBody 
| 参数                   | 参数类型                                                        | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| created_at           | String                                                      | **参数解释**: 资源或操作的创建时间。 **取值范围**: 格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如：2026-05-22T06:30:45.123Z。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| availability_zone_id | String                                                      | **参数解释**: 可用区标识。 **取值范围**: 长度1-256，只能由英文字母、数字及"_"、"-"、"."组成。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| cluster_id           | String                                                      | **参数解释**: 集群唯一标识UUID。 **取值范围**: 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}。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| hyper_group_id       | String                                                      | **参数解释**: 超节点组唯一标识UUID。 **取值范围**: 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}。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| hypernode_id         | String                                                      | **参数解释**: 超节点唯一标识UUID。 **取值范围**: 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}。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| hypernode_image_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}。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| hypernode_type       | String                                                      | **参数解释**: 超节点规格。 **取值范围**: 只能由英文字母、数字及":"、"/"、"_"、"-"组成。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| name                 | String                                                      | **参数解释**: 超节点名称。 **取值范围**: 只能由英文字母、数字及":"、"/"、"_"、"-"组成。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| market_info          | [market_info] object | **参数解释**: 计费模式信息。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| status               | String                                                      | **参数解释**: 超节点状态。 **取值范围**: - PROVISIONING: 超节点创建请求已被接受，但是仍在创建过程中。   - ACTIVE: 超节点处于活动状态，其资源可被使用。   - ERROR: 超节点创建失败。   - TERMINATING: 超节点资源释放中。   - TERMINATED: 超节点资源已经被释放，其资源不再可用。   - TERMINATE_ERROR: 超节点资源释放失败。    |
| frozen_status        | Array of strings                                            | **参数解释**: 冻结状态，非冻结状态时，此状态值为空。 **取值范围**: - ARREAR,DELETABLE: 超节点处于欠费冻结可删除状态。   - POLICE,UNDELETABLE: 超节点处于公安冻结不可删除状态。   - ILLEGAL,DELETABLE: 超节点处于违规冻结可删除状态。   - VERIFY,DELETABLE: 超节点处于未实名冻结可删除状态。                                                                                                                                                                                                                                                                                                                                         |
| tags                 | Array of [TagKv] objects   | **参数解释**: 租户标签。 **取值范围**: 标签数量为0-20。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| updated_at           | String                                                      | **参数解释**: 资源或操作的更新时间。 **取值范围**: 格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如：2026-05-22T06:30:45.123Z。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
   
 表6market_info 
| 参数            | 参数类型   | 描述                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| charging_mode | String | **参数解释**: 付费类型。 **取值范围**: - prePaid: 包周期付费。    |
| order_id      | String | **参数解释**: 订单ID。 **取值范围**: 不涉及。                                                                                                                                                                           |
   
 表7TagKv 
| 参数    | 参数类型   | 描述                                                                                                                                                                                                                 |
|:---|:---|:---|
| key   | String | **参数解释**: 标签键。 **取值范围**: 最大128个Unicode字符。满足'\^((?!\\s)(?!_sys_)\[\\p{L}\\p{Z}\\p{N}_.:/=+-@\]\*)(?\<!\\s)$'。 |
| value | String | **参数解释**: 标签值。 **取值范围**: 最大255个Unicode字符。满足'\^(\[\\p{L}\\p{Z}\\p{N}_.:/=+-@\]\*)$'。                          |
   
 表8PageInfo 
| 参数            | 参数类型    | 描述                                                                                                                                                                        |
|:---|:---|:---|
| next_marker   | String  | **参数解释**: 以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。 **取值范围**: 不涉及。 |
| current_count | Integer | **参数解释** : 当前查询结果数量。 **取值范围** : 不涉及。                                |
   
#### 请求示例
列举超节点信息请求示例。使用场景：用户需要查看当前项目下所有超节点信息时，可调用此接口获取超节点列表。
```
GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/hypernodes
```
#### 响应示例
**状态码：200**
成功获取超节点列表。
```
{
  "page_info" : {
    "next_marker" : "NTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAw",
    "current_count" : 1
  },
  "hypernodes" : [ {
    "hypernode_id" : "d6b9c4e2-5f3a-4b1c-9e7d-8a2f1c3b5e9f",
    "name" : "hyper-node-001",
    "hypernode_type" : "hypernode.high_performance",
    "status" : "ACTIVE",
    "cluster_id" : "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
    "hyper_group_id" : "f1e2d3c4-b5a6-9788-0d1e-2f3a4b5c6d7e",
    "availability_zone_id" : "cn-north-4a"
  } ]
}
```
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 成功获取超节点列表。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-aics/ErrorCode.html)。
