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

创建多云集群 - CreateMultiCloudClusters

功能介绍

创建多云集群

授权信息

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

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

URI

POST /v5/{project_id}/container/kubernetes/multi-cloud/clusters

表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参数

参数

是否必选

参数类型

描述

name

String

集群名称

provider

String

参数解释

集群服务商

约束限制

  • ali:阿里。

  • tencent:腾讯。

  • azure:微软。

  • aws:亚马逊。

  • self_built_hw:华为自建。

  • self_built_idc:IDC自建。

取值范围

字符长度范围0-64

默认取值

不涉及

server

String

集群apiserver地址

image_repo

String

镜像仓地址

image_repo_username

String

镜像仓用户名

image_repo_password

String

镜像仓密码

organization

String

组织

image_repo_type

String

参数解释

镜像仓类型

约束限制

  • harbor:Harbor镜像仓。

  • quay:Quay镜像仓。

  • jfrog:Jfrog镜像仓。

  • other:其他镜像仓。

取值范围

字符长度范围0-64

默认取值

不涉及

current_expiration_date

Long

当前有效期结束时间

certificate_expiration_date

Long

证书有效期结束时间

kube_config

String

kubeconfig文件

image_arch

String

镜像架构类型:

  • x86

  • arm

anp_proxy

String

Anp代理地址

hostguard_proxy

String

Hostguard代理地址

container_name

String

容器名称

dns_policy

String

DNS策略:

  • default:继承集群节点的域名解析配置

  • clusterfirst:查询集群内部的CoreDNS服务

  • clusterfirstwithhostnet:强制在hostNetwork网络模式下使用ClusterFirst策略

  • none:忽略集群的DNS策略,使用自定义DNS配置

dns_config

String

自定义DNS配置,一个或多个IP地址,以分号分隔

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

cluster_id

String

集群id

请求示例

创建多云集群

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

{
  "name" : "ywk-test",
  "provider" : "tencent",
  "server" : "https://lb.kubesphere.local:6443",
  "current_expiration_date" : 1814079596667,
  "certificate_expiration_date" : 1814079596667,
  "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

请求已成功

{
  "cluster_id" : "6f2b5593-7855-4dbd-aebe-4f736708b8db"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档