Help Center/ Host Security Service/ API Reference/ API Description/ Container Installation and Configuration/ Creating a Multi-cloud Cluster
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Creating a Multi-cloud Cluster

Function

This API is used to create a multi-cloud cluster.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Cluster Name

provider

No

String

Definition

cluster service provider.

Constraints

  • ali: Alibaba

  • tencent: Tencent

  • azure: Microsoft

  • aws: AWS

  • self_built_hw: Huawei-built

  • self_built_idc: IDC on-premises

Range

The value can contain 0 to 64 characters.

Default Value

N/A

server

No

String

API server address of a cluster

image_repo

No

String

Image repository address

image_repo_username

No

String

Username of an image repository

image_repo_password

No

String

Password of an image repository

organization

No

String

Organization

image_repo_type

No

String

Definition

Image repository type.

Constraints

  • **harbor: Harbor image repository

  • quay: Quay image repository

  • jfrog: JFrog image repository

  • other: other image repository

Range

The value can contain 0 to 64 characters.

Default Value

N/A

current_expiration_date

No

Long

End time of the current validity period

certificate_expiration_date

No

Long

End time of the certificate validity period

kube_config

Yes

String

kubeconfig file

image_arch

No

String

Image architecture type:

  • x86

  • arm

anp_proxy

No

String

ANP Proxy Address

hostguard_proxy

No

String

Hostguard Proxy Address

container_name

No

String

Container Name

dns_policy

No

String

DNS Policy:

  • default: inherits the domain name resolution configuration of the cluster node.

  • clusterfirst: queries the CoreDNS service in a cluster.

  • clusterfirstwithhostnet: forcibly uses the ClusterFirst policy in hostNetwork mode.

  • none: ignores the DNS policy of the cluster and use the customized DNS configuration.

dns_config

No

String

User-defined DNS configuration. One or more IP addresses are separated by semicolons (;).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

cluster_id

String

Cluster ID

Example Requests

Create a multi-cloud cluster.

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"
}

Example Responses

Status code: 200

Request succeeded.

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

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Installation and Configuration