调用DescribeClusterDetail根据集群ID,查看集群的详细信息。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求和返回结果文档。

请求语法

GET /clusters/[ClusterId] HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String cdde1f21ae22e483ebcb068a6eb7f****

集群ID。

返回数据

名称 类型 示例值 描述
cluster_id String c82e6987e2961451182edacd74faf****

集群ID。

cluster_type String Kubernetes

集群类型。

created String 2019-11-25T15:50:20+08:00

集群的创建时间。

current_version String 1.14.8-aliyun.1

当前集群版本。

deletion_protection Boolean true

是否开启删除保护,防止通过控制台或API删除集群。

docker_version String 18.09.2

Docker版本。

external_loadbalancer_id String lb-2ze3buguz3gx9920z****

集群负载均衡服务的 ID。

instance_type String ""

集群实例类型。

meta_data String ****

集群元数据信息。

name String test-k8s

Kubernetes集群名称。

network_mode String vpc

集群网络模式(VPC网络:vpc)。

region_id String cn-beijing

集群所在地域ID。

resource_group_id String rg-acfmyvw3wjm****

资源组ID。

security_group_id String sg-25yq****

安全组ID。

size Integer 4

节点数。

state String running

集群运行状态

  • running:集群正在运行的。
  • stopped:集群已经停止运行。
  • deleted:集群已经被删除。
  • delete_failed:集群删除失败。
  • failed:集群创建失败。
tags Array

集群标签。

key String type

标签名称。

value String web

标签值。

updated String 2020-01-13T23:01:03+08:00

最后更新时间。

vpc_id String vpc-2zecuu62b9zw7a7qn****

专有网络ID。

vswitch_cidr String ""

虚拟交换机网路的网络前缀。

vswitch_id String "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****"

虚拟交换机ID。

zone_id String cn-beijing-a

集群所在区域。

示例

请求示例

GET /clusters/[ClusterId] HTTP/1.1
公共请求头
{
"ClusterId": "cdde1f21ae22e483ebcb068a6eb7f****"
}

正常返回示例

XML 格式

<resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
<vpc_id>vpc-2zecuu62b9zw7a7qn****</vpc_id>
<deletion_protection>true</deletion_protection>
<created>2019-11-25T15:50:20+08:00</created>
<network_mode>vpc</network_mode>
<region_id>cn-beijing</region_id>
<current_version>1.14.8-aliyun.1</current_version>
<security_group_id>sg-25yq****</security_group_id>
<cluster_type>Kubernetes</cluster_type>
<docker_version>18.09.2</docker_version>
<vswitch_cidr>""</vswitch_cidr>
<tags>
    <value>web</value>
    <key>type</key>
</tags>
<zone_id>cn-beijing-a</zone_id>
<cluster_id>c82e6987e2961451182edacd74faf****</cluster_id>
<size>4</size>
<external_loadbalancer_id>lb-2ze3buguz3gx9920zwf24</external_loadbalancer_id>
<name>test-k8s</name>
<meta_data>****</meta_data>
<vswitch_id>"vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****"</vswitch_id>
<state>running</state>
<instance_type>""</instance_type>
<updated>2020-01-13T23:01:03+08:00</updated>

JSON 格式

{"resource_group_id":"rg-acfmyvw3wjm****","vpc_id":"vpc-2zecuu62b9zw7a7qn****","deletion_protection":"true","created":"2019-11-25T15:50:20+08:00","network_mode":"vpc","region_id":"cn-beijing","current_version":"1.14.8-aliyun.1","security_group_id":"sg-25yq****","cluster_type":"Kubernetes","docker_version":"18.09.2","vswitch_cidr":"\"\"","tags":[{"value":"web","key":"type"}],"zone_id":"cn-beijing-a","cluster_id":"c82e6987e2961451182edacd74faf****","size":"4","external_loadbalancer_id":"lb-2ze3buguz3gx9920z****","name":"test-k8s","meta_data":"****","vswitch_id":"\"vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****\"","state":"running","instance_type":"\"\"","updated":"2020-01-13T23:01:03+08:00"}

错误码

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