View cluster details

更新时间:
复制 MD 格式

Queries the details of a Container Service for Kubernetes (ACK) cluster by cluster ID. The response includes the cluster's configuration, network settings, runtime state, and associated resource identifiers.

For the full API reference, see DescribeClusterDetail.

Prerequisites

Before you begin, ensure that you have:

  • An ACK cluster and its cluster ID

  • The aliyun CLI installed and configured with valid credentials

Query cluster details

Send a GET request to the ACK API endpoint with the target cluster ID:

aliyun cs GET /clusters/<cluster_id>

Replace <cluster_id> with the ID of the target cluster.

Request parameters

ParameterLocationRequiredTypeDescription
cluster_idPathYesStringThe ID of the ACK cluster.

Sample response

{
  "clusterId": "cbfa079eb225c44e7bce86c626f0c****",
  "clusterType": "Kubernetes",
  "created": "2020-11-12T18:51:06+08:00",
  "currentVersion": "1.11.5",
  "deletionProtection": false,
  "dockerVersion": "17.06.2-ce-5",
  "externalLoadbalancerId": "lb-wz9gw2knznrpiv6sj****",
  "instanceType": "ecs.se1ne.xlarge",
  "name": "K8S-f5056244-24d4-11eb-b753-0242ac11****",
  "networkMode": "vpc",
  "regionId": "cn-shenzhen",
  "resourceGroupId": "rg-acfmoiyerhu****",
  "securityGroupId": "sg-wz97gjh27h6jgi41****",
  "size": 5,
  "state": "running",
  "tags": [
    {
      "key": "ack.aliyun.com",
      "value": "cbfa079eb225c44e7bce86c626f0c****"
    }
  ],
  "updated": "2020-11-12T19:04:01+08:00",
  "vpcId": "vpc-wz9rqhtseeylp71x7****",
  "vswitchCidr": "",
  "vswitchId": "vsw-wz999pkyv5ybw4ork****",
  "zoneId": "cn-shenzhen-b"
}

Response fields

FieldTypeDescription
clusterIdStringThe ID of the cluster.
clusterTypeStringThe cluster type. Value: Kubernetes.
createdStringThe time the cluster was created, in ISO 8601 format (UTC+8).
currentVersionStringThe Kubernetes version running on the cluster.
deletionProtectionBooleanSpecifies whether deletion protection is enabled. If true, the cluster cannot be deleted through the console or API.
dockerVersionStringThe Docker version installed on the nodes.
externalLoadbalancerIdStringThe ID of the Server Load Balancer (SLB) instance attached to the cluster's API server.
instanceTypeStringThe ECS instance type of the cluster nodes.
nameStringThe name of the cluster.
networkModeStringThe network mode of the cluster. Value: vpc.
regionIdStringThe region where the cluster is deployed.
resourceGroupIdStringThe ID of the resource group the cluster belongs to.
securityGroupIdStringThe ID of the security group associated with the cluster nodes.
sizeIntegerThe number of nodes in the cluster.
stateStringThe state of the cluster.
tagsArrayThe tags attached to the cluster. Each tag has a key and value.
updatedStringThe time the cluster was last updated, in ISO 8601 format (UTC+8).
vpcIdStringThe ID of the VPC the cluster is deployed in.
vswitchCidrStringThe CIDR block of the vSwitch. Empty if not configured.
vswitchIdStringThe ID of the vSwitch the cluster nodes are attached to.
zoneIdStringThe zone where the cluster is deployed.

References