获取集群安装时所需的配置信息 - CreateClusterConf
功能介绍
获取集群安装时所需的配置信息,当前仅本地集群使用
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/clusters/{clusterid}/clusterconf
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| clusterid | 是 | String | 集群id |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 消息体的类型(格式),仅支持application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| USERNAME | 否 | String | 节点登录用户名 |
| MASTER-1 | 否 | String | 控制节点1的IP地址 |
| MASTER-2 | 否 | String | 控制节点2的IP地址 |
| MASTER-3 | 否 | String | 控制节点3的IP地址 |
| ACCESS_EXTERNAL_LOAD_BALANCE | 否 | Boolean | 是否使用外部负载均衡器(true表示使用EXTERNAL_LOAD_BALANCE_IP,false表示使用VIRTUAL_IP) |
| VIRTUAL_IP | 否 | String | 虚拟IP地址(当ACCESS_EXTERNAL_LOAD_BALANCE为false时必须提供) |
| EXTERNAL_LOAD_BALANCE_IP | 否 | String | 外部负载均衡器IP地址(当ACCESS_EXTERNAL_LOAD_BALANCE为true时必须提供) |
| CILIUM_IPV4POOL_CIDR | 否 | String | Cilium网络组件的IPv4地址池CIDR |
| NETWORK_CIDR | 否 | String | 容器网络的CIDR范围 |
| DNS_SERVER_IP | 否 | String | DNS服务器IP地址 |
| NTP_SERVER_IP | 否 | String | NTP服务器IP地址(可为空,为空时INSTALL_NTP自动设置为false) |
| IAM_DOMAIN_ID | 否 | String | IAM域ID |
| K8S_VERSION | 否 | String | Kubernetes版本号 |
| K8S_ARCH | 否 | String | 系统架构 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| {自定义key} | Map<String,Object> | - |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | String | - |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| - | String | - |
请求示例
用户从前端输入集群配置参数
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"
} 响应示例
状态码:200
集群安装所需的配置信息
{
"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"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 集群安装所需的配置信息 |
| 400 | 客户端请求错误,服务器无法执行请求 |
| 500 | 服务器内部错误 |
错误码
请参见错误码。