您可以调用DescribeClusterDetail接口，根据集群ID查询指定集群的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cs:DescribeClusterDetail | get | *Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId} |
| 无 |
请求语法
GET /clusters/{ClusterId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID。 | cdde1f21ae22e483ebcb068a6eb7f**** |
返回参数
示例
正常返回示例
JSON格式
{
"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",
"next_version": "1.18.8-aliyun.1",
"deletion_protection": true,
"docker_version": "19.03.5",
"external_loadbalancer_id": "lb-2zehc05z3b8dwiifh****",
"meta_data": "\\\"Addons\\\":***",
"name": "cluster-demo",
"network_mode": "vpc",
"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",
"zone_id": "cn-beijing-a",
"master_url": "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.0.251:6443\\\"***}",
"private_zone": false,
"profile": "Default",
"cluster_spec": "ack.pro.small",
"worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
"maintenance_window": {
"enable": false,
"maintenance_time": "2020-10-15T12:31:00.000+08:00",
"duration": "3h",
"weekly_period": "Monday,Thursday",
"recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU"
},
"parameters": {
"key": "WorkerImageId"
},
"container_cidr": "172.20.0.0/16",
"service_cidr": "172.21.0.0/20",
"proxy_mode": "ipvs",
"timezone": "Asia/Shanghai",
"node_cidr_mask": "26",
"ip_stack": "ipv4",
"cluster_domain": "cluster.local",
"vswitch_ids": [
"vsw-2zete8s4qocqg0mf6****"
],
"operation_policy": {
"cluster_auto_upgrade": {
"enabled": true,
"channel": "patch"
}
},
"control_plane_config": {
"charge_type": "PrePaid",
"period": 1,
"period_unit": "Month",
"auto_renew": true,
"auto_renew_period": 1,
"instance_types": [
"ecs.g6.large"
],
"image_type": "AliyunLinux3",
"image_id": "aliyun_3_x64_20G_alibase_20240819.vhd",
"key_pair": "ack",
"system_disk_category": "cloud_essd",
"system_disk_size": 120,
"system_disk_snapshot_policy_id": "sp-2zej1nogjvovnz4z****",
"system_disk_performance_level": "PL1",
"system_disk_provisioned_iops": 1000,
"system_disk_bursting_enabled": true,
"deploymentset_id": "ds-bp10b35imuam5amw****",
"cloud_monitor_flags": true,
"soc_enabled": false,
"security_hardening_os": true,
"cpu_policy": "none",
"runtime": "containerd",
"node_port_range": "30000-32767",
"size": 3
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-10-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-10-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-04-26 | API 内部配置变更，不影响调用 | 查看变更详情 |