Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ UCS Cluster/ Obtaining the Configuration Required for Cluster Installation

Updated on 2026-04-16 GMT+08:00

View PDF

Obtaining the Configuration Required for Cluster Installation

Function

This API is used to obtain the configuration required for cluster installation (currently, only for on-premises clusters).

URI

POST /v1/clusters/{clusterid}/clusterconf

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
clusterid	Yes	String	Cluster ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). Only application/json is supported.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
USERNAME	No	String	Node login username
MASTER-1	No	String	IP address of control node 1
MASTER-2	No	String	IP address of control node 2
MASTER-3	No	String	IP address of control node 3
ACCESS_EXTERNAL_LOAD_BALANCE	No	Boolean	Whether to use an external load balancer (true indicates that EXTERNAL_LOAD_BALANCE_IP is used, and false indicates that VIRTUAL_IP is used.)
VIRTUAL_IP	No	String	Virtual IP address (mandatory when ACCESS_EXTERNAL_LOAD_BALANCE is set to false)
EXTERNAL_LOAD_BALANCE_IP	No	String	IP address of the external load balancer (mandatory when ACCESS_EXTERNAL_LOAD_BALANCE is set to true)
CILIUM_IPV4POOL_CIDR	No	String	CIDR block of the IPv4 address pool of the Cilium network component
NETWORK_CIDR	No	String	Container network CIDR block
DNS_SERVER_IP	No	String	IP address of a DNS server
NTP_SERVER_IP	No	String	IP address of the NTP server (The value can be an empty string. If the value is an empty string, INSTALL_NTP is automatically set to false.)
IAM_DOMAIN_ID	No	String	IAM domain ID
K8S_VERSION	No	String	Kubernetes version
K8S_ARCH	No	String	System architecture

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
{User defined key}	Map<String,Object>	-

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
-	String	-

Example Requests

Cluster configuration parameters entered by the user on the frontend

POST https://ucs.myhuaweicloud.com/v1/clusters/{clusterid}/clusterconf

{
  "USERNAME" : "root",
  "MASTER-1" : "1.1.1.1",
  "MASTER-2" : "2.1.1.1",
  "MASTER-3" : "3.1.1.1",
  "ACCESS_EXTERNAL_LOAD_BALANCE" : false,
  "CILIUM_IPV4POOL_CIDR" : "10.16.0.0/16",
  "NETWORK_CIDR" : "10.16.0.0/16",
  "DNS_SERVER_IP" : "3.1.1.1",
  "NTP_SERVER_IP" : "null",
  "IAM_DOMAIN_ID" : "a934cc67ec7e4910b04098cc5689505b"
}

Example Responses

Status code: 200

Configuration required for cluster installation returned

{
  "ACCESS_EXTERNAL_LOAD_BALANCE" : false,
  "CILIUM_IPV4POOL_CIDR" : "10.16.0.0/16",
  "DNS_SERVER_IP" : "3.1.1.1",
  "IAM_DOMAIN_ID" : "a934cc67ec7e4910b04098cc5689505b",
  "IAM_ENDPOINT" : "https://iam.cn-north-5.ulanqab.huawei.com",
  "IMAGES_PACKAGE_PATH" : "https://ucs-onprem.obs.cn-north-5.ulanqab.huawei.com/packages/ucs-onpremise/25.3.0/ucs-onpremise_images_25.3.0.2_amd64.tar.gz",
  "INSTALL_NTP" : false,
  "MASTER-1" : "1.1.1.1",
  "MASTER-2" : "2.1.1.1",
  "MASTER-3" : "3.1.1.1",
  "NETWORK_CIDR" : "10.16.0.0/16",
  "NETWORK_PROVIDER" : "cilium",
  "NTP_SERVER_IP" : "null",
  "PACKAGE_PATH" : "https://ucs-onprem.obs.cn-north-5.ulanqab.huawei.com/packages/ucs-onpremise/25.3.0/ucs-onpremise_25.3.0.2_amd64.tar.gz",
  "PROXY_MODE" : "ebpf",
  "TAINT_MANAGE" : "yes",
  "TIMEZONE" : "Asia/Shanghai",
  "USERNAME" : "root",
  "VIRTUAL_IP" : "4.1.1.1"
}