调用DescribeClustersV1查询集群列表-边缘节点服务 ENS-阿里云

查询集群列表

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeClustersV1

create

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Name	string	否	集群名称。	test-eck-name
ClusterId	string	否	集群 ID。	eck-xxxxxxxx
EnsRegionId	string	否	集群所在 ENS Region ID。	cn-hangzhou-58

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Clusters	array<object>	集群信息列表。
	array<object>	集群详细信息。
ClusterId	string	集群实例 ID。	eck-xxxxxxx
Name	string	集群名称。	test-eck-name
AliUid	string	用户 ID。	1375383353108460
EnsRegionId	string	ENS 节点 ID。	cn-hangzhou-55
KubernetesVersion	string	集群版本，与 Kubernetes 社区基线版本保持一致。建议选择最新版本，若不指定，默认使用最新版本。	1.31.9-aliyunedge.1
VpcId	string	集群使用的专有网络。	n-5wsgr3xeolb2ist303wp3cscp
VswitchIds	array	集群节点所在虚拟交换机 id。vswitch_ids 所处 ENS Region 必须与 ens_region_id 一致。
	string	虚拟交换机 id。	vsw-xxxxxxx
PodVswitchIds	array	每个 Pod 虚拟交换机分别对应一个 Worker 节点的虚拟交换机，Pod 虚拟交换机和 Worker 节点的虚拟交换机的可用区需保持一致。如果不填，默认使用 vswitch_ids。
	string	虚拟交换机 id。	vsw-xxxxxxx
ContainerCidr	string	Pod 网络地址段，必须是有效的私有网段，即以下网段及其子网：10.0.0.0/8、172.16-31.0.0/12-16、192.168.0.0/16。不能与 VPC 及 VPC 内已有 Kubernetes 集群使用的网段重复，创建成功后不能修改。	10.0.0.0/8
ServiceCidr	string	Service 网络地址段，可选范围：10.0.0.0/16-24，172.16-31.0.0/16-24，192.168.0.0/16-24 不能与 VPC 网段 10.1.0.0/21 及 VPC 内已有 Kubernetes 集群使用的网段重复，创建成功后不能修改。	192.168.0.0/16
PublicAccess	boolean	是否开启公网访问。通过 EIP 暴露 API Server，实现集群公网访问。 ● true：开启公网访问。 ● false：不开启公网访问。选择不开放时，则无法通过外网访问集群 API Server。	true
LoadBalancerId	string	负载均衡实例 ID。	lb-58dngw0fyimzzvwljfec7hy0z
ControlPlaneConfig	object	控制平面配置。
InstanceSpec	string	实例规格。	ens.sn1.medium
ImageId	string	镜像 ID。	m-68be8cb9f71fhyvjekxa23qsf
SystemDiskCategory	string	节点系统盘类型，可选类型："local_ssd", "cloud_ssd", "cloud_efficiency", "local_hdd"。	cloud_ssd
SystemDiskSize	integer	系统盘大小规格，单位：GB。	100
ContainerRuntime	string	运行时类型。	containerd
NodePortRange	string	节点服务端口范围。	30000-32767
Size	integer	控制面节点数量。	5
JoinToken	string	集群接入鉴权 token。	xxxxxxxxxx.yyyyyyy
Config	any	集群 kubeconfig。	{ "kind": "Config", "apiVersion": "v1", "preferences": {}, "clusters": [ { "name": "kubernetes", "cluster": { "server": "https://000.000.000.000:6443", "certificate-authority-data": "" } } ], "users": [ { "name": "kubernetes-admin", "user": { "client-certificate-data": "", "client-key-data": "" } } ], "contexts": [ { "name": "kubernetes-admin@kubernetes", "context": { "cluster": "kubernetes", "user": "kubernetes-admin" } } ], "current-context": "kubernetes-admin@kubernetes" }
State	string	集群状态。	running

示例

正常返回示例

JSON格式

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Clusters": [
    {
      "ClusterId": "eck-xxxxxxx",
      "Name": "test-eck-name",
      "AliUid": "1375383353108460",
      "EnsRegionId": "cn-hangzhou-55",
      "KubernetesVersion": "1.31.9-aliyunedge.1",
      "VpcId": "n-5wsgr3xeolb2ist303wp3cscp",
      "VswitchIds": [
        "vsw-xxxxxxx"
      ],
      "PodVswitchIds": [
        "vsw-xxxxxxx"
      ],
      "ContainerCidr": "10.0.0.0/8",
      "ServiceCidr": "192.168.0.0/16",
      "PublicAccess": true,
      "LoadBalancerId": "lb-58dngw0fyimzzvwljfec7hy0z",
      "ControlPlaneConfig": {
        "InstanceSpec": "ens.sn1.medium",
        "ImageId": "m-68be8cb9f71fhyvjekxa23qsf",
        "SystemDiskCategory": "cloud_ssd",
        "SystemDiskSize": 100,
        "ContainerRuntime": "containerd",
        "NodePortRange": "30000-32767",
        "Size": 5
      },
      "JoinToken": "xxxxxxxxxx.yyyyyyy",
      "Config": "{\n        \"kind\": \"Config\",\n        \"apiVersion\": \"v1\",\n        \"preferences\": {},\n        \"clusters\": [\n          {\n            \"name\": \"kubernetes\",\n            \"cluster\": {\n              \"server\": \"https://000.000.000.000:6443\",\n              \"certificate-authority-data\": \"\"\n            }\n          }\n        ],\n        \"users\": [\n          {\n            \"name\": \"kubernetes-admin\",\n            \"user\": {\n              \"client-certificate-data\": \"\",\n              \"client-key-data\": \"\"\n            }\n          }\n        ],\n        \"contexts\": [\n          {\n            \"name\": \"kubernetes-admin@kubernetes\",\n            \"context\": {\n              \"cluster\": \"kubernetes\",\n              \"user\": \"kubernetes-admin\"\n            }\n          }\n        ],\n        \"current-context\": \"kubernetes-admin@kubernetes\"\n      }",
      "State": "running"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
400	BadRequest	请求参数错误
400	ClusterNameExist	集群名称已存在
400	UnsupportedClusterVersion	不支持的集群版本
400	ClusterNameFormatError	集群名称格式错误
400	ClusterCountExceed	集群数量超限
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
500	InternalServerError	内部服务错误

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

变更历史

更多信息，参考变更详情。