全部产品
Search

搜索本产品

    容器服务 Kubernetes 版 ACK：DescribeClustersForRegion - 查询指定地域的集群列表

    文档中心

    容器服务 Kubernetes 版 ACK：DescribeClustersForRegion - 查询指定地域的集群列表

    更新时间：Dec 09, 2024

    查询指定地域内全部集群列表。

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cs:DescribeClustersForRegionlist
    *全部资源
    *
      无
    		无

    请求语法

    GET /regions/{region_id}/clusters HTTP/1.1

    请求参数

    名称类型必填描述示例值
    namestring否

    通过集群名称进行模糊查询。

    		test-cluster
    cluster_typestring否

    查询指定类型的集群，可取值：

    • Kubernetes: ACK 专有集群。
    • ManagedKubernetes：ACK 托管类的集群，包括 ACK 托管集群（ACK 集群 Pro 版、ACK 集群基础版）、ACK Serverless 集群（Pro 版、基础版）、ACK Edge 集群（Pro 版、基础版）、ACK 灵骏集群（Pro 版）。
    • ExternalKubernetes：注册集群。
    		Kubernetes
    page_sizelong否

    每页记录数量。

    		3
    page_numberlong否

    页数。

    		10
    profilestring否

    查询指定子类型的集群，可取值：

    • Default：ACK 托管集群，包括 ACK 集群 Pro 版和 ACK 集群基础版。
    • Edge：ACK Edge 集群，包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。
    • Serverless：ACK Serverless 集群，包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。
    • LingJun：ACK 灵骏集群，提供 Pro 版。
    		Serverless
    cluster_specstring否

    查询指定规格的集群，可取值：

    • ack.pro.small：Pro 版。
    • ack.standard：基础版。
    		ack.standard
    cluster_idstring否

    集群 ID。

    		c8155823d057948c69a****
    region_idstring是

    地域。

    		cn-hangzhou

    返回参数

    名称类型描述示例值
    object

    返回数据体。

    clustersarray<object>

    集群详情列表。

    clustersobject

    集群详情。

    cluster_idstring

    集群 ID。

    		c905d1364c2dd4b6284a3f41790c4****
    cluster_typestring

    集群类型：

    • Kubernetes: ACK 专有集群。
    • ManagedKubernetes：ACK 托管类的集群，包括 ACK 托管集群（ACK 集群 Pro 版、ACK 集群基础版）、ACK Serverless 集群（Pro 版、基础版）、ACK Edge 集群（Pro 版、基础版）、ACK 灵骏集群（Pro 版）。
    • ExternalKubernetes：注册集群。
    		ManagedKubernetes
    createdstring

    集群创建时间。

    		2020-12-01T20:40:40+08:00
    init_versionstring

    集群初始版本。

    		1.16.6-aliyun.1
    current_versionstring

    集群当前版本。

    		1.16.6-aliyun.1
    next_versionstring

    集群可升级版本。

    		1.18.8-aliyun.1
    deletion_protectionboolean

    集群删除保护，防止通过控制台或 API 误删除集群。取值：

    • true：启用集群删除保护，将不能通过控制台或 API 删除集群。
    • false：不启用集群删除保护，则能通过控制台或 API 删除集群。
    		false
    namestring

    集群名称。

    		test-cluster
    profilestring

    集群子类型：

    • Default：ACK 托管集群，包括 ACK 集群 Pro 版和 ACK 集群基础版。
    • Edge：ACK Edge 集群，包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。
    • Serverless：ACK Serverless 集群，包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。
    • LingJun：ACK 灵骏集群，提供 Pro 版。
    		Default
    region_idstring

    地域 ID。

    		cn-beijing-a
    resource_group_idstring

    集群资源组 ID。

    		rg-acfmyvw3wjm****
    security_group_idstring

    集群安全组 ID。

    		sg-2zeihch86ooz9io4****
    container_cidrstring

    集群 Pod 网络网段。

    		172.20.0.0/16
    service_cidrstring

    服务网络网段。

    		172.21.0.0/20
    proxy_modestring

    集群 kube-proxy 代理模式。

    枚举值：
    • iptables：iptables。
    • ipvs：ipvs。
    		ipvs
    timezonestring

    时区。

    		Asia/Shanghai
    ip_stackstring

    集群的 IP 协议栈。

    		ipv4
    cluster_domainstring

    集群本地域名

    		cluster.local
    sizelong

    集群节点数。

    		2
    statestring

    集群运行状态，取值：

    • initial：集群创建中。
    • failed：集群创建失败。
    • running：集群运行中。
    • upgrading：集群升级中。
    • scaling：集群伸缩中。
    • waiting：等待接入状态。
    • disconnected：断开状态。
    • inactive：集群不活跃。
    • unavailable：集群不可用。
    • deleting：集群删除中。
    • deleted：集群已经被删除。
    • delete_failed：集群删除失败。
    		running
    tagsarray

    集群标签列表。

    tagtag

    集群标签。

    updatedstring

    集群更新时间。

    		2020-12-08T15:37:00+08:00
    vpc_idstring

    集群所在的 VPC ID。

    		vpc-2zeg8nf1ukc0fcmvq****
    vswitch_idsarray

    集群控制面虚拟交换机列表。

    vswitch_idstring

    集群控制面虚拟交换机。

    		vsw-2vc41xuumx5z2rdma****
    cluster_specstring

    托管版集群规格：

    • ack.pro.small：Pro 版。
    • ack.standard：基础版。
    		ack.standard
    page_infoobject

    分页信息。

    page_numberinteger

    页数。

    		1
    page_sizeinteger

    每页记录数量。

    		10
    total_countinteger

    结果总数。

    		10

    示例

    正常返回示例

    JSON格式

    {
  "clusters": [
    {
      "cluster_id": "c905d1364c2dd4b6284a3f41790c4****",
      "cluster_type": "ManagedKubernetes",
      "created": "2020-12-01T20:40:40+08:00",
      "init_version": "1.16.6-aliyun.1",
      "current_version": "1.16.6-aliyun.1",
      "next_version": "1.18.8-aliyun.1",
      "deletion_protection": false,
      "name": "test-cluster",
      "profile": "Default",
      "region_id": "cn-beijing-a",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "security_group_id": "sg-2zeihch86ooz9io4****",
      "container_cidr": "172.20.0.0/16",
      "service_cidr": "172.21.0.0/20",
      "proxy_mode": "ipvs",
      "timezone": "Asia/Shanghai",
      "ip_stack": "ipv4",
      "cluster_domain": "cluster.local",
      "size": 2,
      "state": "running",
      "tags": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "updated": "2020-12-08T15:37:00+08:00",
      "vpc_id": "vpc-2zeg8nf1ukc0fcmvq****",
      "vswitch_ids": [
        "vsw-2vc41xuumx5z2rdma****"
      ],
      "cluster_spec": "ack.standard"
    }
  ],
  "page_info": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 10
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史