DescribeClusterDetail
Description
call the DescribeClusterDetail to view the details of the cluster according to the cluster ID.
Request Method
POST
Request Path
/apsara/route/CS/DescribeClusterDetail
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| ClusterId | BODY | string | Yes | cdde1f21ae22e483ebcb068a6eb7f**** | cluster ID. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| resource_group_id | string | No sample value for this parameter. | cluster resource group ID. |
| private_zone | boolean | No sample value for this parameter. | Cluster Private Zone configuration. true: Enable Private Zone. false: Private Zone is not enabled. |
| vpc_id | string | No sample value for this parameter. | cluster proprietary network ID, required when creating a cluster. |
| network_mode | string | No sample value for this parameter. | cluster network mode, value: classic: classic network. vpc: proprietary network. overlay: overlay network. calico:Calico network. default value:vpc. |
| security_group_id | string | No sample value for this parameter. | cluster security group ID. |
| cluster_type | string | No sample value for this parameter. | cluster type, value: Kubernetes:Kubernetes proprietary version ManagedKubernetes: edge managed cluster |
| docker_version | string | No sample value for this parameter. | Docker version in the cluster. |
| next_version | string | No sample value for this parameter. | The cluster can be upgraded. |
| zone_id | string | No sample value for this parameter. | zone ID where the cluster is located. |
| cluster_id | string | No sample value for this parameter. | cluster ID. |
| external_loadbalancer_id | string | No sample value for this parameter. | cluster Ingress SLB instance ID. |
| meta_data | string | No sample value for this parameter. | cluster metadata information. |
| vswitch_id | string | No sample value for this parameter. | virtual switch ID, you can select 1 to 3 virtual switches when creating a cluster. To ensure high availability of the cluster, we recommend that you select virtual switches in different zones. |
| state | string | No sample value for this parameter. | cluster running status, value: initial: The cluster is being created. failed: cluster creation failed. running: The cluster is running. updating: cluster upgrade. updating_failed: cluster upgrade failed. scaling: cluster scaling. stopped: The cluster has stopped running. deleting: The cluster is being deleted. deleted: The cluster has been deleted. delete_failed: cluster deletion failed. |
| init_version | string | No sample value for this parameter. | cluster initialization version. |
| created | string | No sample value for this parameter. | cluster creation time. |
| deletion_protection | boolean | No sample value for this parameter. | cluster deletion protection to prevent misdeletion of clusters through the console or API. Value: true: enable cluster deletion protection, and clusters cannot be deleted through the console or API. false: cluster deletion protection is not enabled, the cluster can be deleted through the console or API. |
| subnet_cidr | string | No sample value for this parameter. | Pod network address segment must be a valid private network segment, I .e. the following network segment and its subnet: 10.0.0.0/8 172.16-31.0.0/12-16 192.168.0.0/16 cannot duplicate network segments used by VPC and existing Kubernetes clusters in VPC, and cannot be modified after successful creation. |
| profile | string | No sample value for this parameter. | cluster type when facing the scene: Default: non-edge scene cluster. Edge: edge scene cluster. |
| region_id | string | No sample value for this parameter. | the region ID of the cluster. |
| master_url | string | No sample value for this parameter. | cluster access address, including intranet access address and public network access address. |
| current_version | string | No sample value for this parameter. | current version of the cluster. |
| tags | array of tag | No sample value for this parameter. | cluster resource tag. |
| size | long | No sample value for this parameter. | Number of cluster nodes, including Master nodes and Worker nodes. |
| name | string | No sample value for this parameter. | cluster name. naming rule: consists of numbers, Chinese characters, English characters, or dashes (-), and the length ranges from 1 to 63 characters, and cannot start with a dash (-). |
| updated | string | No sample value for this parameter. | cluster update time. |
| worker_ram_role_name | string | No sample value for this parameter. | Worker RAM role name. The ECS instance is authorized to be the Woker node of the cluster. |
Example
Successful Response example
"The successful response sample is not recognizable. Please modify API definition in API gateway before re-create the API document."
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}