文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器安装与配置/ 解析多云集群的配置文件 - ParseMultiCloudClusterConfig
更新时间:2025-10-31 GMT+08:00
分享

解析多云集群的配置文件 - ParseMultiCloudClusterConfig

功能介绍

解析多云集群的配置文件

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/container/kubernetes/multi-cloud/config-analyze

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

kube_config

String

kubeconfig文件

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

total_num

Integer

集群总数

data_list

Array of MultiCloudClusterConfigInfo objects

多云集群的集群配置列表

表6 MultiCloudClusterConfigInfo

参数

参数类型

描述

address

String

apiserver的地址

certificate_expiration_date

Long

证书有效期结束时间

请求示例

解析多云集群的配置文件

POST https://{endpoint}/v5/{project_id}/container/kubernetes/multi-cloud/config-analyze?enterprise_project_id=all_granted_eps

{
  "kube_config" : "apiVersion: v1\r\n\r\nclusters:\r\n\r\n- cluster:\r\n\r\n    certificate-authority-data: xxx=\r\n\r\n    server: https://lb.kubesphere.local:6443\r\n\r\n  name: cluster.local\r\n\r\ncontexts:\r\n\r\n- context:\r\n\r\n    cluster: cluster.local\r\n\r\n    user: kubernetes-admin\r\n\r\n  name: kubernetes-admin@cluster.local\r\n\r\ncurrent-context: kubernetes-admin@cluster.local\r\n\r\nkind: Config\r\n\r\npreferences: {}\r\n\r\nusers:\r\n\r\n- name: kubernetes-admin\r\n\r\n  user:\r\n\r\n    client-certificate-data: xxx=\r\n\r\n    client-key-data: xxx=\r\n"
}

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "address" : "https://lb.kubesphere.local:6443",
    "certificate_expiration_date" : 1814079244623
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档