# 查询超节点规格列表-ListHypernodeTypes
#### 功能介绍
查询指定项目下当前用户可见的超节点规格列表，仅返回有权限访问的规格。
接口保障最终一致性。该接口为公开接口，需要用户Token鉴权。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/AICS/doc?api=ListHypernodeTypes)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-aics/aics_05_0700.html)。
| 授权项                      | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| aics::listHypernodeTypes | List | -           | -   | -  | -      |
   
#### URI
GET /v2/{project_id}/hypernode-types
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释**: 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-aics/aics_api_0702.html)。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| family | 否    | String  | **参数解释**: 规格族名称，用于按规格族过滤查询结果。 **约束限制**: 不涉及。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 **默认取值**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| status | 否    | String  | **参数解释**: 规格售卖状态，用于按状态过滤查询结果。 **约束限制**: 不涉及。 **取值范围**: - obt: 公测，规格处于公测阶段。   - normal: 正常，规格对所有用户开放购买。   - sellout: 售罄，规格资源已售完，暂不可购买。   - abandon: 废弃，规格已废弃，不可购买。    **默认取值**: 不涉及。 |
| marker | 否    | String  | **参数解释**: 分页标记，本次请求获取该标记后的资源，base64编码。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| limit  | 否    | Integer | **参数解释**: 分页查询单页记录数量。 **约束限制**: 不涉及。 **取值范围**: 1\~100。 **默认取值**: 20。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | **参数解释**: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**: 不涉及。 **取值范围**: 不涉及。 **默认取值**: 不涉及。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数              | 参数类型                                                                          | 描述                                                                                                                                                                      |
|:---|:---|:---|
| hypernode_types | Array of [HypernodeType] objects | **参数解释**: 当前用户可见的超节点规格列表，列表元素为超节点规格对象。 **取值范围**: 不涉及。 |
| page_info       | [PageInfo] object                     | **参数解释**: 分页信息。 **取值范围**: 不涉及。                        |
   
 表5HypernodeType 
| 参数           | 参数类型                                                            | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|
| id           | String                                                          | **参数解释**: 超节点规格标识，用于唯一标识一个超节点规格。创建超节点时需指定此标识来选择对应的规格。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| family       | String                                                          | **参数解释**: 规格族名称，用于标识超节点所属的规格族。同一规格族下的超节点具有相似的硬件配置特征。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| product_info | [ProductInfo] object | **参数解释**: 超节点规格的产品信息，包含计费模式、服务类型等。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| node_info    | [NodeInfo] object       | **参数解释**: 超节点中计算节点的规格信息，包含节点数量、CPU、内存等配置。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| npu_info     | [NpuInfo] object         | **参数解释**: 超节点中NPU设备的规格信息，包含NPU型号、数量、集群网络等配置。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| network_info | [NetworkInfo] object | **参数解释**: 超节点的业务网络规格信息，包含最大网卡数量等配置。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| volume_info  | [VolumeInfo] object   | **参数解释**: 超节点的云硬盘规格信息，包含最大云硬盘数量等配置。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| status       | String                                                          | **参数解释**: 超节点规格的售卖状态，用于标识规格当前的可用性。 **取值范围**: - obt: 公测，规格处于公测阶段。   - normal: 正常，规格对所有用户开放购买。   - sellout: 售罄，规格资源已售完，暂不可购买。   - abandon: 废弃，规格已废弃，不可购买。    |
   
 表6ProductInfo 
| 参数                 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| charge_mode        | String | **参数解释**: 超节点规格支持的计费模式，用于确定资源的付费方式。 **取值范围**: - prePaid: 包周期计费   - postPaid: 按需计费    |
| service_type       | String | **参数解释**: 服务类型，用于标识该规格所属的服务类别。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。                                                                                                                                                                                                                                                                                                                                                                |
| resource_type      | String | **参数解释**: 资源类型，用于标识该规格对应的资源类别。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。                                                                                                                                                                                                                                                                                                                                                                |
| resource_spec_code | String | **参数解释**: 资源规格编码，用于在计费系统中唯一标识该规格对应的资源规格。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。                                                                                                                                                                                                                                                                                                                                                      |
   
 表7NodeInfo 
| 参数               | 参数类型                                                                          | 描述                                                                                                                                                                                      |
|:---|:---|:---|
| count            | Integer                                                                       | **参数解释**: 超节点中包含的计算节点总数。该参数用于描述超节点的计算规模，决定超节点可提供的计算能力。 **取值范围**: 不涉及。 |
| cpu_info         | [CpuInfo] object                       | **参数解释**: 计算节点的CPU规格信息，包含vCPU数量等配置。 **取值范围**: 不涉及。                    |
| memory_info      | [MemoryInfo] object                 | **参数解释**: 计算节点的内存规格信息，包含内存大小等配置。 **取值范围**: 不涉及。                       |
| local_disk_infos | Array of [LocalDiskInfo] objects | **参数解释**: 计算节点的本地磁盘规格信息列表，包含本地盘类型、数量和容量等配置。 **取值范围**: 不涉及。            |
   
 表8CpuInfo 
| 参数    | 参数类型    | 描述                                                                                                                                                                                       |
|:---|:---|:---|
| vcpus | Integer | **参数解释**: 每个计算节点的vCPU数量。该参数用于描述单个计算节点的CPU算力，影响超节点的计算性能。 **取值范围**: 不涉及。 |
   
 表9LocalDiskInfo 
| 参数      | 参数类型    | 描述                                                                                                                                                                                                     |
|:---|:---|:---|
| type    | String  | **参数解释**: 本地盘类型，用于标识本地盘的存储介质类型，影响磁盘的IO性能。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。 |
| count   | Integer | **参数解释**: 同类型本地盘的数量。该参数用于描述超节点中同类型本地盘的配置数量，影响节点的本地存储能力。 **取值范围**: 不涉及。               |
| size_gb | Integer | **参数解释**: 单块本地盘的容量大小，单位为GiB。该参数用于描述单块本地盘的存储容量，影响节点的本地存储空间。 **取值范围**: 不涉及。            |
   
 表10NpuInfo 
| 参数                   | 参数类型                                                                          | 描述                                                                                                                                                                                                                                   |
|:---|:---|:---|
| name                 | String                                                                        | **参数解释**: NPU设备型号，用于标识NPU的具体产品型号，决定NPU的计算能力和特性。 **取值范围**: 长度1-64，只能由英文字母、数字及"_"、"-"、"."组成。                         |
| count                | Integer                                                                       | **参数解释**: 单个计算节点中NPU设备数量。该参数用于描述单个计算节点的NPU算力规模。 **取值范围**: 最小1，最大64。                                                |
| cluster_network_info | [ClusterNetworkInfo] object | **参数解释**: NPU集群的参数面网络信息，包含参数面网络接口数量等配置。 **取值范围**: 不涉及。                                                             |
| topology             | String                                                                        | **参数解释**: NPU集群的拓扑结构，形式为MxN，其中M表示行数，N表示列数。该参数用于描述NPU设备之间的互联拓扑关系，影响NPU集群的通信效率。 **取值范围**: 格式为MxN，M和N均为正整数，且总长度不超过25。 |
| memory_info          | [MemoryInfo] object                 | **参数解释**: NPU设备的内存规格信息，包含内存大小等配置。 **取值范围**: 不涉及。                                                                   |
| peak_compute         | Array of [PeakCompute] objects     | **参数解释**: NPU设备的峰值算力信息列表，每个元素包含一种精度类型及其对应的算力值和单位。该参数用于描述NPU在不同精度下的峰值计算性能。 **取值范围**: 列表长度1-16。                      |
| bandwidth_gbs        | Long                                                                          | **参数解释**: NPU设备的显存带宽，单位为GB/s。该参数用于描述NPU显存的数据传输速率，影响大规模模型训练时的数据吞吐能力。 **取值范围**: 不涉及。                                 |
   
 表11ClusterNetworkInfo 
| 参数                              | 参数类型    | 描述                                                                                                                                                                                           |
|:---|:---|:---|
| cluster_network_interface_count | Integer | **参数解释**: 参数面网络接口数量。该参数用于描述NPU集群参数面通信的网络接口数量，影响NPU集群间的通信带宽。 **取值范围**: 不涉及。 |
   
 表12MemoryInfo 
| 参数      | 参数类型 | 描述                                                                                                                                                                                      |
|:---|:---|:---|
| size_gb | Long | **参数解释**: 内存大小，单位为GB。该参数用于描述计算节点或NPU的内存容量，影响节点的数据处理能力。 **取值范围**: 不涉及。 |
   
 表13PeakCompute 
| 参数        | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|
| precision | String | **参数解释**: 算力精度类型，用于标识算力值的计算精度。 **取值范围**: - FP64: 双精度浮点。   - FP32: 单精度浮点。   - FP16: 半精度浮点。   - BF16: Bfloat16。   - FP8: 8位浮点 (E4M3/E5M2)。   - INT8: 8位整型。   - INT4: 4位整型。    |
| value     | Long   | **参数解释**: 算力值，与精度和单位配合描述NPU的计算性能。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| unit      | String | **参数解释**: 算力单位，用于标识算力值的计量单位。 **取值范围**: - TFLOPS: 每秒万亿次浮点运算。   - PFLOPS: 每秒千万亿次浮点运算。   - TOPS: 每秒万亿次运算。   - POPS: 每秒千万亿次运算。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
   
 表14NetworkInfo 
| 参数                  | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| max_interface_count | Integer | **参数解释**: 超节点最大支持挂载的业务网卡数量。该参数用于限制超节点可挂载的业务网卡上限，影响节点的网络扩展能力。 **取值范围**: 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                            |
| uboe_supported      | Boolean | **参数解释**: 超节点是否支持UBoE（Universal Blade Optical Ethernet）高速网络。该参数用于标识超节点是否具备UBoE高速网络接入能力，影响节点的网络通信性能。 **取值范围**: - true: 支持UBoE   - false: 不支持UBoE    |
   
 表15VolumeInfo 
| 参数               | 参数类型    | 描述                                                                                                                                                                                          |
|:---|:---|:---|
| max_volume_count | Integer | **参数解释**: 超节点最大支持挂载的云硬盘数量。该参数用于限制超节点可挂载的云硬盘上限，影响节点的存储扩展能力。 **取值范围**: 不涉及。 |
   
 表16PageInfo 
| 参数            | 参数类型    | 描述                                                                                                                                                                                    |
|:---|:---|:---|
| next_marker   | String  | **参数解释**: 以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。 **取值范围**: 不涉及。 |
| current_count | Integer | **参数解释** : 当前查询结果数量。 **取值范围** : 不涉及。                                |
   
#### 请求示例
- 查询超节点规格列表请求示例。使用场景：用户需要查看当前项目下可用的超节点规格列表时，通过此接口获取规格信息。
  ```
  GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/hypernode-types?limit=10
  ```
  
- 查询超节点规格列表请求示例（带过滤条件）。使用场景：用户需要按规格族和状态过滤查询超节点规格时，通过此接口获取符合条件的规格列表。
  ```
  GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/hypernode-types?family=ka5n&status=normal
  ```
  
 
#### 响应示例
**状态码：200**
OK
```
{
  "hypernode_types" : [ {
    "id" : "aics.a5-e.64.superpod",
    "family" : "ka5n",
    "product_info" : {
      "charge_mode" : "prePaid",
      "service_type" : "hws.service.type.aics",
      "resource_type" : "hws.resource.type.npucluster",
      "resource_spec_code" : "aics.a5-e.64.superpod"
    },
    "node_info" : {
      "count" : 8,
      "cpu_info" : {
        "vcpus" : 192
      },
      "memory_info" : {
        "size_gb" : 2304
      }
    },
    "npu_info" : {
      "name" : "950DT",
      "count" : 8,
      "cluster_network_info" : {
        "cluster_network_interface_count" : 64
      },
      "topology" : "8x8",
      "memory_info" : {
        "size_gb" : 96
      },
      "peak_compute" : [ {
        "precision" : "FP16",
        "value" : 486,
        "unit" : "TFLOPS"
      } ],
      "bandwidth_gbs" : 4096
    },
    "network_info" : {
      "max_interface_count" : 5,
      "uboe_supported" : true
    },
    "volume_info" : {
      "max_volume_count" : 15
    },
    "status" : "normal"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-aics/ErrorCode.html)。
