文档首页/ 灵衢智算集群/ API参考/ API/ 超节点组/ 查询超节点组列表-ListHyperGroups
更新时间:2026-10-08 GMT+08:00
分享

查询超节点组列表-ListHyperGroups

功能介绍

查询指定项目下的超节点组列表,支持通过id和cluster_id筛选,支持分页。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

aics::listHyperGroups

List

-

-

-

-

URI

GET /v2/{project_id}/hyper-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

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}。

默认取值:

不涉及。

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}。

默认取值:

不涉及。

limit

否

Integer

参数解释:

分页查询单页记录数量。

约束限制:

不涉及。

取值范围:

1~100。

默认取值:

20。

marker

否

String

参数解释:

分页标记,本次请求获取该标记后的资源,base64编码。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

page_info

PageInfo object

参数解释:

分页信息。

取值范围:

不涉及。

hyper_groups

Array of HyperGroup objects

参数解释:

超节点组列表。

取值范围:

不涉及。

表5 PageInfo

参数

参数类型

描述

next_marker

String

参数解释:

以单页最后一条资源标识作为分页标记,base64编码。用于请求下一页使用的分页标记。

取值范围:

不涉及。

current_count

Integer

参数解释 :

当前查询结果数量。

取值范围 :

不涉及。

表6 HyperGroup

参数

参数类型

描述

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}。

name

String

参数解释:

超节点组名称,自动生成。

取值范围:

长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。

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}。

created_at

String

参数解释:

资源或操作的创建时间。

取值范围:

格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如:2026-05-22T06:30:45.123Z。

请求示例

查询超节点组列表请求示例。使用场景:用户需要查看当前项目下所有超节点组信息时,可调用此接口获取超节点组列表。

GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/hyper-groups

响应示例

状态码:200

成功获取超节点组列表。

{
  "page_info" : {
    "next_marker" : "NTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDAw",
    "current_count" : 1
  },
  "hyper_groups" : [ {
    "id" : "550e8400-e29b-41d4-a716-446655440000",
    "name" : "default_group_my-hypernode-01_AAAY8u5cnAA",
    "cluster_id" : "660e8400-e29b-41d4-a716-446655440001",
    "created_at" : "2026-05-20T10:00:00.000Z"
  } ]
}

状态码

状态码

描述

200

成功获取超节点组列表。

错误码

请参见错误码。

相关文档