跳转到主要内容
平台运维相关接口/平台联邦

查询集群组列表

列表集群组可用联邦。

GET/api/v1/federation/cluster-groups

操作 ID

ListClusterGroups

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

此接口无需请求参数。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • items
    List

    条目列表。

    示例: (nested array)

    • id
      String

      资源ID。

      示例: cg-001-xyz

    • name
      String

      资源名称。

      示例: production-clusters

    • description
      String

      资源的详细描述。

      示例: All production environment clusters

    • clusterIds
      List

      集群ID。

      示例: item1,item2

    • createdAt
      String

      创建时间。

      示例: 2026-01-15T08:00:00Z

  • total
    Integer

    返回结果总数。

    示例: 5

  • limit
    Integer

    最大返回条目数。

    示例: 20

  • offset
    Integer

    查询起始偏移量。

    示例: 20