查询多云集群 - ListMultiCloudClusters
功能介绍
查询多云集群
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/container/kubernetes/multi-cloud/clusters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
cluster_id |
否 |
String |
集群id |
|
offset |
否 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
集群总数 |
|
data_list |
Array of MultiCloudClusterInfo objects |
多云集群的集群信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_id |
String |
集群id |
|
cluster_name |
String |
集群名称 |
|
provider |
String |
集群服务商 |
|
server |
String |
集群apiserver地址 |
|
image_repo |
String |
镜像仓地址 |
|
status |
String |
参数解释 anp-agent的连接状态 取值范围
|
|
version |
String |
anp-agent的版本 |
|
current_expiration_date |
Long |
当前有效期结束时间 |
|
certificate_expiration_date |
Long |
证书有效期结束时间 |
请求示例
无
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"cluster_id" : "b075094b-d21a-499a-9006-624089c94402",
"cluster_name" : "ywk-55555",
"provider" : "self_built_hw",
"server" : "https://lb.kubesphere.local:6443",
"image_repo" : "swr.cn-north-7.myhuaweicloud.com",
"status" : "not_connect",
"version" : "0.0.2",
"current_expiration_date" : 1814080859608,
"certificate_expiration_date" : 1814080859608
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
