Retrieve ENS Cluster Lists via DescribeClustersV1 - ENS - Alibaba Cloud - ENS

Queries a list of clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeClustersV1

create

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the cluster.	test-eck-name
ClusterId	string	No	The ID of the cluster.	eck-xxxxxxxx
EnsRegionId	string	No	The ID of the ENS region where the cluster is located.	cn-hangzhou-58

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	C0003E8B-B930-4F59-ADC0-0E209A9012A8
Clusters	array<object>	A list of cluster information.
	array<object>	The details of the cluster.
ClusterId	string	The ID of the cluster instance.	eck-xxxxxxx
Name	string	The name of the cluster.	test-eck-name
AliUid	string	The user ID.	1375383353108460
EnsRegionId	string	The ID of the ENS edge zone.	cn-hangzhou-55
KubernetesVersion	string	The cluster version. It is consistent with the baseline version of the Kubernetes community. Select the latest version. If you do not specify a version, the latest version is used by default.	1.31.9-aliyunedge.1
VpcId	string	The virtual private cloud (VPC) used by the cluster.	n-5wsgr3xeolb2ist303wp3cscp
VswitchIds	array	The IDs of the virtual switches to which the cluster nodes belong. The virtual switches must be in the region specified by `ens_region_id`.
	string	The ID of the virtual switch.	vsw-xxxxxxx
PodVswitchIds	array	Each pod virtual switch corresponds to a virtual switch of a worker node. The zone of the pod virtual switch and the worker node virtual switch must be the same. If you do not specify this parameter, the value of vswitch_ids is used by default.
	string	The ID of the virtual switch.	vsw-xxxxxxx
ContainerCidr	string	The CIDR block for pods. It must be a valid private CIDR block, such as 10.0.0.0/8, 172.16-31.0.0/12-16, or 192.168.0.0/16, and their subnets. This CIDR block cannot overlap with the VPC CIDR block or the CIDR blocks of existing Kubernetes clusters in the VPC. After the cluster is created, this parameter cannot be changed.	10.0.0.0/8
ServiceCidr	string	The CIDR block for services. Valid ranges: 10.0.0.0/16-24, 172.16-31.0.0/16-24, and 192.168.0.0/16-24. The CIDR block cannot overlap with the VPC CIDR block 10.1.0.0/21 or the CIDR blocks used by existing Kubernetes clusters in the VPC. This parameter cannot be changed after the cluster is created.	192.168.0.0/16
PublicAccess	boolean	Specifies whether to enable public network access. The API server is exposed through an elastic IP address (EIP) to allow public access to the cluster. Valid values are `true` and `false`. If set to `true`, public network access is enabled. If set to `false`, public network access is disabled, and you cannot access the cluster API server from the internet.	true
LoadBalancerId	string	The ID of the Server Load Balancer (SLB) instance.	lb-58dngw0fyimzzvwljfec7hy0z
ControlPlaneConfig	object	The control plane configuration.
InstanceSpec	string	The instance type.	ens.sn1.medium
ImageId	string	The image ID.	m-68be8cb9f71fhyvjekxa23qsf
SystemDiskCategory	string	The type of the system disk for the edge zone. Valid values: "local_ssd", "cloud_ssd", "cloud_efficiency", and "local_hdd".	cloud_ssd
SystemDiskSize	integer	The size of the system disk, in GB.	100
ContainerRuntime	string	The type of the runtime.	containerd
NodePortRange	string	The range of service ports on the node.	30000-32767
Size	integer	The number of control plane nodes.	5
JoinToken	string	The authentication token for accessing the cluster.	xxxxxxxxxx.yyyyyyy
Config	any	The kubeconfig of the cluster.	{ "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	The status of the cluster.	running

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.