文档

ListClusters - 查询集群列表

更新时间:

查询集群实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

a3f2224a5ec7224116c4f5246120abe4
MaxResultslong

分页查询时每页行数,默认值为 20。

20
ResourceGroupIdstring

资源组 id

rg-aek2bg6wyoox6jq

返回参数

名称类型描述示例值
object
RequestIdstring

请求 id

2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1
Clustersarray<object>

集群信息

object
Componentsany

组件信息

{}
ClusterIdstring

集群 id

i137590131672134915401
ClusterNamestring

集群 name

cnp_test_cluster
OperatingStatestring

集群状态

枚举值:
  • running运行中
  • expanding扩容中
  • shrinking缩容中
  • initializing初始化中
initializing
TaskIdstring

任务 id

i156365121663149566024
ClusterTypestring

集群类型

枚举值:
  • AckEdgePro基于ACK@Edge Pro的灵骏集群
  • ExclusiveBareCluster专属裸集群
  • Lite基础版灵骏集群
AckEdgePro
NodeCountlong

节点数量

12
NodeGroupCountlong

节点组数量

2
CreateTimestring

创建时间

1672134938
UpdateTimestring

更新时间

1672134968
ClusterDescriptionstring

集群描述

测试集群
ResourceGroupIdstring

资源组 id

rg-aek2ajbjoloa23q
VpcIdstring

专有网络 id

vpc-0jlx4hol2bjboafzmffvd
HpnZonestring

集群编号

B1
NextTokenstring

本次调用返回的查询凭证值。

f4f9a292c17072a2

示例

正常返回示例

JSON格式

{
  "RequestId": "2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1",
  "Clusters": [
    {
      "Components": "{}",
      "ClusterId": "i137590131672134915401",
      "ClusterName": "cnp_test_cluster",
      "OperatingState": "initializing",
      "TaskId": "i156365121663149566024",
      "ClusterType": "AckEdgePro",
      "NodeCount": 12,
      "NodeGroupCount": 2,
      "CreateTime": "1672134938",
      "UpdateTime": "1672134968",
      "ClusterDescription": "测试集群",
      "ResourceGroupId": "rg-aek2ajbjoloa23q",
      "VpcId": "vpc-0jlx4hol2bjboafzmffvd",
      "HpnZone": "B1",
      "ComputingIpVersion": ""
    }
  ],
  "NextToken": "f4f9a292c17072a2"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-07OpenAPI 返回结构发生变更查看变更详情
2023-09-21OpenAPI 返回结构发生变更查看变更详情
2023-08-20OpenAPI 返回结构发生变更查看变更详情