DescribeAckClusters - 批量查询ACK集群

查询阿里云K8S容器服务(ACK)集群,查询符合条件的ACK集群(例如指定集群类型、集群规格)列表信息。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

RegionNo

string

ACK 集群地域 ID。

cn-hangzhou

MemberUid

string

ACK 集群资源所属的阿里云 UID。

135809047715****

PageSize

string

分页参数:每页显示条数。

10

PageNo

string

页码。

1

ClusterId

string

ACK 集群 ID。

cb0f5640b1b2d404cad6ba21509d7847b

ClusterName

string

ACK 集群名称。

ack-cluster-name

ClusterSpec

string

ACK 集群规格。

枚举值:

  • ack.pro.small :

    集群 Pro 版

ack.pro.small

ConnectorStatus

string

ACK 集群连接器实例状态。

ready

返回参数

名称

类型

描述

示例值

object

Clusters

array<object>

ACK 集群列表。

object

ACK 集群。

MemberUid

string

ACK 集群资源所属的阿里云 UID。

135809047715****

RegionId

string

ACK 集群地域 ID。

cn-hangzhou

ClusterId

string

ACK 集群 ID。

cb0f5640b1b2d404cad6ba21509d7847b

ClusterName

string

ACK 集群名称。

ack-cluster-name

ClusterType

string

ACK 集群类型。取值来源:

  • DescribeClustersV1 :查看本账号下符合条件的 ACK 集群(例如指定集群类型、集群规格)列表信息。

枚举值:

  • ExternalKubernetes :

    注册集群。

  • ManagedKubernetes :

    ACK 托管类的集群,包括 ACK 托管集群(Pro 版、基础版)、ACK Serverless 集群(Pro 版、基础版)、ACK Edge 集群(Pro 版、基础版)、ACK 灵骏集群(Pro 版)。

  • Kubernetes :

    ACK 专有集群。

ManagedKubernetes

Profile

string

当您选择cluster_typeManagedKubernetes时,即 ACK 托管类的集群时,您可以进一步指定集群的子类型。取值来源:

  • DescribeClustersV1 :查看本账号下符合条件的 ACK 集群(例如指定集群类型、集群规格)列表信息。

枚举值:

  • Lingjun :

    ACK 灵骏集群,提供 Pro 版。

  • Serverless :

    ACK Serverless 集群,包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。

  • Default :

    ACK 托管集群,包括 ACK 集群 Pro 版和 ACK 集群基础版。

  • Edge :

    ACK Edge 集群,包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。

Default

VpcId

string

ACK 集群所属 VPC 实例 ID。

vpc-2vcg932hsxsxuqbgl****

Network

string

ACK 集群网络插件。取值来源:

  • DescribeClustersV1 :查看本账号下符合条件的 ACK 集群(例如指定集群类型、集群规格)列表信息。

枚举值:

  • terway-eniip :

    Terway-eniip

  • Flannel :

    Flannel

terway-eniip

ClusterSpec

string

ACK 集群规格。

枚举值:

  • ack.pro.small :

    集群 Pro 版

ack.pro.small

State

string

ACK 集群运行状态。取值来源:

  • DescribeClustersV1 :查看本账号下符合条件的 ACK 集群(例如指定集群类型、集群规格)列表信息。

枚举值:

  • running :

    集群运行中

  • scaling :

    集群伸缩中

  • stopped :

    集群已经停止运行

  • upgrading :

    集群升级中

  • updating :

    集群配置变更中

  • deleting :

    集群删除中

  • deleted :

    集群已经被删除

  • initial :

    集群创建中

  • draining :

    节点排水中

  • delete_failed :

    集群删除失败

  • failed :

    集群创建失败

  • removing :

    节点移除中

running

PageNo

integer

页码。

1

PageSize

integer

分页参数:每页显示条数。

10

RequestId

string

请求 ID。

C5DDD596-1191-5F36-A504-8733045A****

TotalCount

integer

总数。

1

示例

正常返回示例

JSON格式

{
  "Clusters": [
    {
      "MemberUid": "135809047715****",
      "RegionId": "cn-hangzhou",
      "ClusterId": "cb0f5640b1b2d404cad6ba21509d7847b",
      "ClusterName": "ack-cluster-name",
      "ClusterType": "ManagedKubernetes",
      "Profile": "Default",
      "VpcId": "vpc-2vcg932hsxsxuqbgl****",
      "Network": "terway-eniip",
      "ClusterSpec": "ack.pro.small",
      "State": "running"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "C5DDD596-1191-5F36-A504-8733045A****",
  "TotalCount": 1
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorParametersUid The aliUid parameter is invalid. aliUid 不合法
400 ErrorParameters Parameters error. 参数错误。
400 ErrorDBSelect An error occurred while querying database. 内部错误:数据库查询错误
400 ErrorRegionNo regionNo error. 地域选择错误, 请重新输入。
500 ErrorAckNotOpen ACK service is not open.

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

变更历史

更多信息,参考变更详情