建立一個新的Kubernetes叢集執行個體,並建立指定數量的節點。

請求資訊

請求行 RequestLine

POST /clusters HTTP/1.1 

特有要求標頭 RequestHead

無,請參考公用要求標頭部

請求體 RequestBody

{
	"disable_rollback": "失敗是否復原",
	"name": "叢集名稱",
	"timeout_mins": 叢集建立逾時時間,
	"cluster_type": "叢集類型,ManagedKubernetes",
	"region_id": "地區",
	"vpcid": "VPC ID",
	"zoneid": "可用性區域",
	"vswitchid": "交換器ID",	
	"container_cidr": "容器POD CIDR",
	"service_cidr": "服務CIDR",
	"cloud_monitor_flags":"是否安裝Cloud Monitor外掛程式",
	"login_password": "節點SSH登陸密碼,和key_pair二選一",
	"key_pair":"keypair名稱,和login_password 二選一",
	"worker_instance_charge_type":"Worker節點付費類型PrePaid|PostPaid",
	"worker_period_unit":"訂用帳戶單位,Month,Year,只有在PrePaid下生效",
	"worker_period":"訂用帳戶時間長度,只有在PrePaid下生效",
	"worker_auto_renew":"Worker節點自動續約true|false",
	"worker_auto_renew_period":"Worker節點續約周期",
	"worker_instance_type": "Worker執行個體規格",
	"worker_system_disk_category": "Worker系統硬碟類型",
	"worker_system_disk_size": "Worker節點系統硬碟大小",
	"worker_data_disk":"是否掛載資料盤 true|false",
	"worker_data_disk_category":"資料盤類型",
	"worker_data_disk_size":"資料盤大小",
	"num_of_nodes": "Worker節點數",
	"snat_entry": 是否配置SNATEntry,
}

請求體解釋

名稱 類型 必須 描述
disable_rollback bool 失敗是否復原:
  • true:表示失敗不復原
  • false:表示失敗復原
如果選擇失敗復原,則會釋放建立過程中所生產的資源,不推薦使用false
name string 叢集名稱,叢集名稱可以使用大小寫英文字母、中文、數字、中劃線
timeout_mins int 叢集資源棧建立逾時時間,以分鐘為單位,預設值 60分鐘
region_id string 叢集所在地區ID
zoneid string 所屬地區的可用性區域
vpcid string VPC ID,可空。如果不設定,系統會自動建立VPC,系統建立的VPC網段為192.168.0.0/16。 VpcId 和 vswitchid 只能同時為空白或者同時都設定相應的值
vswitchid string 交換器ID,可空。若不設定,系統會自動建立交換器,系統自定建立的交換器網段為 192.168.0.0/16
container_cidr string 容器網段,不能和VPC網段衝突。當選擇系統自動建立VPC時,預設使用172.16.0.0/16網段
service_cidr string 服務網段,不能和VPC網段以及容器網段衝突。當選擇系統自動建立VPC時,預設使用172.19.0.0/20網段
worker_instance_charge_type string Worker節點付費類型,可選值為:
  • PrePaid:預付費
  • PostPaid:隨用隨付
worker_period_unit string 當指定為PrePaid的時候需要指定周期。可選擇為:
  • Week:以周為計時單位
  • Month:以月為計時單位
worker_period int 訂用帳戶時間長度,當worker_instance_charge_type取值為PrePaid時才生效且為必選值,取值範圍:
  • PeriodUnit=Week時,Period取值:{“1”, “2”, “3”, “4”},
  • PeriodUnit=Month時,Period取值:{ “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”,”48”,”60”}
worker_auto_renew bool 是否開啟Worker節點自動續約,可選值為:
  • true:自動續約
  • false:不自動續約
worker_auto_renew_period int 自動續約周期,當worker_instance_charge_type取值為PrePaid時才生效且為必選值:
  • PeriodUnit=Week時,取值:{“1”, “2”, “3”},
  • PeriodUnit=Month時,取值{“1”, “2”, “3”, “6”, “12”}
worker_data_disk string 是否掛載資料盤,可選擇:
  • true:表示worker節點掛載資料盤
  • false:表示worker節點不掛載資料盤
worker_data_disk_category int 資料盤類型
worker_data_disk_size string 資料盤大小
worker_instance_type string Worker 節點 ECS 規格類型代碼。更多詳細資料,參見執行個體規格類型系列
worker_system_disk_category string Worker節點系統硬碟類型
worker_system_disk_size int Worker節點系統硬碟大小
login_password string SSH登入密碼。密碼規則為8 - 30 個字元,且同時包含三項(大、小寫字母,數字和特殊符號)。和key_pair 二選一
key_pair string keypair名稱。與login_password二選一
num_of_nodes int Worker節點數。範圍是[0,300]
snat_entry bool 是否為網路設定SNAT。如果是自動建立VPC必須設定為true。如果使用已有VPC則根據是否具備出網能力來設定
cloud_monitor_flags bool 是否安裝Cloud Monitor外掛程式

返回資訊

返回行 ResponseLine

HTTP/1.1 202 Accepted

特有返回頭 ResponseHead

無,請參考公用返回頭部

返回體 ResponseBody

{
"cluster_id":"string",
"request_id":"string",
"task_id":"string"
}

樣本

請求樣本

POST /clusters HTTP/1.1
<公用要求標頭>
{
"disable_rollback": true,
"name": "my-test-Kubernetes-cluster",
"timeout_mins": 60,
"cluster_type": "ManagedKubernetes",
"region_id": "cn-beijing",
"zoneid": "cn-beijing-f",
"vpcid": "",
"vswitchid": "",
"num_of_nodes": 1,
"container_cidr": "172.16.0.0/16",
"service_cidr": "172.19.0.0/20",
"cloud_monitor_flags": true,
"master_instance_type": "ecs.sn1ne.large",
"master_system_disk_category": "cloud_efficiency",
"master_system_disk_size": 40,

"worker_instance_type": "ecs.sn1ne.large",
"worker_system_disk_category": "cloud_efficiency",
"worker_system_disk_size": 40,

"snat_entry": true,
"login_password": "Hello1234"

}

返回樣本

HTTP/1.1 202 Accepted
<公用回應標頭>
{
    "cluster_id": "cb95aa626a47740afbf6aa099b650d7ce",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1",
    "task_id": "T-5a54309c80282e39ea00002f"
}