All Products
Search
Document Center

Container Service for Kubernetes:DescribeClusterDetail

Last Updated:Feb 29, 2024

You can call the DescribeClusterDetail operation to query the details of a Container Service for Kubernetes (ACK) cluster by cluster ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeClusterDetailRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

GET /clusters/{ClusterId}

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

cdde1f21ae22e483ebcb068a6eb7f****

Response parameters

ParameterTypeDescriptionExample
object

The response body parameters.

cluster_idstring

The cluster ID.

c82e6987e2961451182edacd74faf****
cluster_typestring

The type of cluster. Valid values:

  • Kubernetes: ACK dedicated cluster
  • ManagedKubernetes: ACK managed cluster
  • Ask: ACK Serverless cluster
  • ExternalKubernetes: registered cluster
Kubernetes
createdstring

The time when the cluster was created.

2019-11-25T15:50:20+08:00
init_versionstring

The initial Kubernetes version of the cluster.

1.16.6-aliyun.1
current_versionstring

The current Kubernetes version of the cluster. For more information about the Kubernetes versions supported by ACK, see Release notes for Kubernetes versions.

1.16.6-aliyun.1
deletion_protectionboolean

Indicates whether deletion protection is enabled for the cluster. If deletion protection is enabled, the cluster cannot be deleted in the Container Service console or by calling API operations. Valid values:

  • true: deletion protection is enabled for the cluster. This way, the cluster cannot be deleted in the Container Service console or by calling API operations.
  • false: deletion protection is disabled for the cluster. This way, the cluster can be deleted in the Container Service console or by calling API operations.
true
docker_versionstring

The Docker version that is used by the cluster.

19.03.5
meta_datastring

The metadata of the cluster.

\"Addons\":***
namestring

The name of the cluster.

The name must be 1 to 63 characters in length, and can contain digits, letters, and hyphens (-). The name cannot start with a hyphen (-).

cluster-demo
region_idstring

The region ID of the cluster.

cn-beijing
resource_group_idstring

The ID of the resource group to which the cluster belongs.

rg-acfmyvw3wjm****
security_group_idstring

The ID of the security group to which the cluster belongs.

sg-25yq****
sizelong

The number of nodes in the cluster. Master nodes and worker nodes are included.

5
statestring

The status of the cluster. Valid values:

  • initial: The cluster is being created.
  • failed: The cluster failed to be created.
  • running: The cluster is running.
  • updating: The cluster is being updated.
  • updating_failed: The cluster failed to be updated.
  • scaling: The cluster is being scaled.
  • waiting: The cluster is waiting for connection requests.
  • disconnected: The cluster is disconnected.
  • stopped: The cluster is stopped.
  • deleting: The cluster is being deleted.
  • deleted: The cluster is deleted.
  • delete_failed: The cluster failed to be deleted.
running
tagsarray

The resource labels of the cluster.

tag

The resource labels of the cluster.

updatedstring

The time when the cluster was updated.

2020-01-13T23:01:03+08:00
vpc_idstring

The ID of the VPC where the cluster is deployed. This parameter is required when you create a cluster.

vpc-2zecuu62b9zw7a7qn****
vswitch_idstring

The IDs of the vSwitches. You can select one to three vSwitches when you create a cluster. We recommend that you select vSwitches in different zones to ensure high availability.

vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****
subnet_cidrstring

The pod CIDR block. It must be a valid and private CIDR block, and must be one of the following CIDR blocks or their subnets:

  • 10.0.0.0/8
  • 172.16-31.0.0/12-16
  • 192.168.0.0/16

The pod CIDR block cannot overlap with the CIDR block of the VPC or the CIDR blocks of the clusters in the VPC.

For more information, see Plan CIDR blocks for an ACK cluster.

172.20.0.0/16
master_urlstring

The endpoints of the cluster, including an internal endpoint and a public endpoint.

{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}
profilestring

Indicates the scenario in which the cluster is used. Valid values:

  • Default: non-edge computing scenarios
  • Edge: edge computing scenarios
Default
cluster_specstring

The edition of the cluster if the cluster is an ACK managed cluster. Valid values:

  • ack.pro.small: ACK Pro
  • ack.standard: ACK Basic
ack.pro.small
worker_ram_role_namestring

The name of the worker Resource Access Management (RAM) role. The RAM role is assigned to the worker nodes of the cluster to allow the worker nodes to manage Elastic Compute Service (ECS) instances.

KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
maintenance_windowmaintenance_window

The maintenance window of the cluster. This feature is available only in ACK Pro clusters.

parametersobject

The ROS parameters of the cluster.

string

The ROS parameter

WorkerImageId

Examples

Sample success responses

JSONformat

{
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "cluster_type": "Kubernetes",
  "created": "2019-11-25T15:50:20+08:00",
  "init_version": "1.16.6-aliyun.1",
  "current_version": "1.16.6-aliyun.1",
  "deletion_protection": true,
  "docker_version": "19.03.5",
  "meta_data": "\\\"Addons\\\":***",
  "name": "cluster-demo",
  "region_id": "cn-beijing",
  "resource_group_id": "rg-acfmyvw3wjm****",
  "security_group_id": "sg-25yq****",
  "size": 5,
  "state": "running",
  "tags": [
    {
      "key": "env",
      "value": "prod"
    }
  ],
  "updated": "2020-01-13T23:01:03+08:00",
  "vpc_id": "vpc-2zecuu62b9zw7a7qn****",
  "vswitch_id": "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****",
  "subnet_cidr": "172.20.0.0/16",
  "master_url": "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.0.251:6443\\\"***}",
  "profile": "Default",
  "cluster_spec": "ack.pro.small",
  "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
  "maintenance_window": {
    "enable": false,
    "maintenance_time": "03:00:00Z",
    "duration": "3h",
    "weekly_period": "Monday,Thursday"
  },
  "parameters": {
    "key": "WorkerImageId"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history