获取集群详情-ShowCluster
功能介绍
通过集群ID获取用户的集群详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| aics::getCluster | Read | - | - | - | - |
URI
GET /v2/{project_id}/clusters/{cluster_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| cluster_id | 是 | String | 参数解释: 集群唯一标识UUID。 约束限制: 不涉及。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 集群唯一标识UUID。 取值范围: UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。 |
| name | String | 参数解释: 集群名称。 取值范围: 长度1-64,只能由英文字母、数字及"_"、"-"、"."组成。 |
| availability_zone_id | String | 参数解释: 可用区标识。 取值范围: 长度1-256,只能由英文字母、数字及"_"、"-"、"."组成。 |
| created_at | String | 参数解释: 资源或操作的创建时间。 取值范围: 格式为yyyy-MM-dd'T'HH:mm:ss.SSSXXX。例如:2026-05-22T06:30:45.123Z。 |
请求示例
获取集群详情请求示例。使用场景:用户需要查看指定集群的详细信息时,通过集群ID获取集群详情。
GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/clusters/c69808bd-6832-49d4-8c04-fe631f7640c5 响应示例
状态码:200
成功获取集群详情。
{
"id" : "550e8400-e29b-41d4-a716-446655440000",
"name" : "prod-cluster-main-01",
"availability_zone_id" : "cn-north-4a",
"created_at" : "2026-05-20T10:00:00Z"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功获取集群详情。 |
错误码
请参见错误码。