通過OpenAPI創(chuàng)建專有版安全沙箱Kubernetes集群
調(diào)用CreateCluster創(chuàng)建一個(gè)專有版安全沙箱Kubernetes集群。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求語法
POST /clusters HTTP/1.1
Content-Type:application/json
{
"addons" : [ {
"name" : "String",
"config" : "String",
"disabled" : Boolean
} ],
"cloud_monitor_flags" : Boolean,
"cluster_type" : "String",
"container_cidr" : "String",
"cpu_policy" : "String",
"deletion_protection" : Boolean,
"disable_rollback" : Boolean,
"endpoint_public_access" : Boolean,
"is_enterprise_security_group" : Boolean,
"key_pair" : "String",
"kubernetes_version" : "String",
"login_password" : "String",
"master_auto_renew" : Boolean,
"master_auto_renew_period" : Long,
"master_count" : Long,
"master_vswitch_ids" : [ "String" ],
"master_instance_types" : [ "String" ],
"master_system_disk_category" : "String",
"master_system_disk_size" : Long,
"master_system_disk_snapshot_policy_id" : "String",
"master_instance_charge_type" : "String",
"master_period_unit" : "String",
"master_period" : Long,
"name" : "String",
"node_cidr_mask" : "String",
"node_port_range" : "String",
"num_of_nodes" : Long,
"pod_vswitch_ids" : [ "String" ],
"proxy_mode" : "String",
"region_id" : "String",
"runtime" : {
"name" : "String",
"version" : "String"
},
"service_cidr" : "String",
"security_group_id" : "String",
"snat_entry" : Boolean,
"ssh_flags" : Boolean,
"tags" : [ {
"key" : "String",
"value" : "String"
} ],
"taints" : [ {
"key" : "String",
"value" : "String",
"effect" : "String"
} ],
"timeout_mins" : Long,
"user_data" : "String",
"vpcid" : "String",
"vswitch_ids" : [ "String" ],
"worker_auto_renew" : Boolean,
"worker_auto_renew_period" : Long,
"worker_data_disks" : [ {
"category" : "String",
"size" : Long,
"encrypted" : "String",
"auto_snapshot_policy_id" : "String"
} ],
"worker_vswitch_ids" : [ "String" ],
"worker_instance_types" : [ "String" ],
"worker_system_disk_category" : "String",
"worker_system_disk_size" : Long,
"worker_instance_charge_type" : "String",
"worker_period_unit" : "String",
"worker_period" : Long,
"zone_id" : "String"
}
請(qǐng)求參數(shù)
表 1. 請(qǐng)求Body參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
addons | Array | 是 | [{"name": "terway-eniip","config": ""}, {"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\",\"sls_project_name\":\"your_sls_project_name\"}"}, {"name":"nginx-ingress-controller","config":"{\"IngressSlbNetworkType\":\"internet\"}"}] | Kubernetes集群的安裝的組件列表:
|
cloud_monitor_flags | Boolean | 否 | true | 集群是否安裝云監(jiān)控插件。取值:
默認(rèn)值: |
cluster_type | String | 是 | Kubernetes | 集群類型。創(chuàng)建專有版安全沙箱集群時(shí),只能選擇 |
container_cidr | String | 否 | 172.20.0.0/16 | Pod網(wǎng)絡(luò)地址段,不能和VPC網(wǎng)段沖突。當(dāng)選擇系統(tǒng)自動(dòng)創(chuàng)建VPC時(shí),默認(rèn)使用172.16.0.0/16網(wǎng)段。當(dāng)創(chuàng)建Flannel網(wǎng)絡(luò)類型的集群時(shí),該字段為必填。 |
cpu_policy | String | 否 | none | 節(jié)點(diǎn)CPU管理策略。當(dāng)集群版本在1.12.6及以上時(shí)支持以下兩種策略:
默認(rèn)值: |
deletion_protection | Boolean | 否 | true | 集群是否開啟集群刪除保護(hù),防止通過控制臺(tái)或API誤刪除集群。取值:
默認(rèn)值: |
disable_rollback | Boolean | 否 | true | 集群創(chuàng)建失敗是否回滾。取值:
默認(rèn)值: |
endpoint_public_access | Boolean | 否 | true | 是否開啟公網(wǎng)API Server。取值:
默認(rèn)值: |
is_enterprise_security_group | Boolean | 否 | true | 自動(dòng)創(chuàng)建企業(yè)級(jí)安全組,當(dāng)
默認(rèn)值: |
key_pair | String | 是 | security-key | 密鑰對(duì)名稱,和 |
kubernetes_version | String | 否 | 1.16.9-aliyun.1 | 集群版本,與Kubernetes社區(qū)基線版本保持一致。建議選擇最新版本,若不指定,默認(rèn)使用最新版本。目前您可以在ACK控制臺(tái)創(chuàng)建兩種最新版本的集群。您可以通過API創(chuàng)建其他Kubernetes版本集群。關(guān)于ACK支持的Kubernetes版本,請(qǐng)參見Kubernetes版本發(fā)布概覽。 |
login_password | String | 是 | Hello@1234 | SSH登錄密碼,和 |
master_auto_renew | Boolean | 否 | true | Master節(jié)點(diǎn)是否開啟自動(dòng)續(xù)費(fèi),當(dāng)
默認(rèn)值: |
master_auto_renew_period | Long | 否 | 1 | Master節(jié)點(diǎn)自動(dòng)續(xù)費(fèi)周期,當(dāng)選擇包年包月付費(fèi)類型時(shí)才生效,且為必選項(xiàng)。 取值范圍:{1, 2, 3, 6, 12}。 默認(rèn)值:1。 |
master_count | Long | 否 | 3 | Master節(jié)點(diǎn)數(shù)量,取值3或5。 默認(rèn)值:3。 |
master_instance_charge_type | String | 否 | PrePaid | Master節(jié)點(diǎn)付費(fèi)類型,取值:
默認(rèn)為 |
master_instance_types | Array of String | 否 | ["ecs.n4.xlarge"] | Master節(jié)點(diǎn)實(shí)例類型。指定的實(shí)例規(guī)格數(shù)量需要和 |
master_period | Long | 否 | 1 | Master節(jié)點(diǎn)包年包月時(shí)長(zhǎng),當(dāng) 取值范圍:{1, 2, 3, 6, 12, 24, 36, 48, 60}。 默認(rèn)值:1。 |
master_period_unit | String | 否 | Month | Master節(jié)點(diǎn)付費(fèi)周期,當(dāng)付費(fèi)類型為 取值: |
master_system_disk_category | String | 否 | cloud_ssd | Master節(jié)點(diǎn)系統(tǒng)盤類型,取值:
默認(rèn)值: |
master_system_disk_size | Long | 否 | 120 | Master節(jié)點(diǎn)系統(tǒng)盤類型,取值范圍[40,500],單位:GiB。 默認(rèn)值:120。 |
master_system_disk_performance_level | String | 否 | PL1 | 集群Master節(jié)點(diǎn)系統(tǒng)盤磁盤性能等級(jí), 僅對(duì)ESSD磁盤生效。磁盤性能等級(jí)和磁盤大小有關(guān)。更多信息,請(qǐng)參見ESSD云盤。 |
master_vswitch_ids | Array of String | 否 | ["vsw-2ze3ds0mdip0hdz8i****"] | Master節(jié)點(diǎn)虛擬交換機(jī)ID。 |
name | String | 是 | cluster-demo | 集群名稱。 命名規(guī)則:由數(shù)字、漢字、英文字符或短劃線(-)組成,長(zhǎng)度范圍1~63個(gè)字符,且不能以短劃線(-)開頭。 |
node_cidr_mask | String | 否 | 25 | 節(jié)點(diǎn)IP數(shù)量,通過指定網(wǎng)絡(luò)的CIDR來確定IP的數(shù)量,只對(duì)于Flannel網(wǎng)絡(luò)類型集群生效。 默認(rèn)值:25。 |
node_port_range | String | 否 | 30000~32767 | 節(jié)點(diǎn)服務(wù)端口。取值范圍為[30000,65535]。 |
num_of_nodes | Long | 是 | 3 | Worker節(jié)點(diǎn)數(shù)。范圍是[0,100]。 |
pod_vswitch_ids | Array of String | 否 | ["vsw-2ze97jwri7cei0mpw****"] | Pod的虛擬交換機(jī)列表。 說明 Terway網(wǎng)絡(luò)類型必須要指定 您需要為每一個(gè)節(jié)點(diǎn)虛擬交換機(jī)指定至少一個(gè)相同可用區(qū)的Pod虛擬交換機(jī),并且不能跟節(jié)點(diǎn) |
proxy_mode | String | 否 | ipvs | kube-proxy代理模式,支持 默認(rèn)值: |
region_id | String | 是 | cn-beijing | 集群所在的地域ID。 |
runtime | 是 | {"name": "Sandboxed-Container.runv", "version": "2.2.0"} | 集群內(nèi)容器運(yùn)行時(shí)。支持
runtime包括以下2個(gè)信息:
重要 在創(chuàng)建安全沙箱集群的場(chǎng)景下,只能選擇 容器運(yùn)行時(shí)版本,默認(rèn)為最新版。關(guān)于安全沙箱運(yùn)行時(shí)的變更詳情,請(qǐng)參見安全沙箱運(yùn)行時(shí)發(fā)布記錄。 | |
security_group_id | String | 否 | sg-bp1bdue0qc1g7k**** | 使用已有安全組創(chuàng)建集群時(shí)需要指定安全組ID,集群節(jié)點(diǎn)自動(dòng)加入到此安全組,和 |
service_cidr | String | 是 | 172.21.0.0/20 | Service網(wǎng)絡(luò)地址段,不能和VPC網(wǎng)段及Pod網(wǎng)絡(luò)網(wǎng)段沖突。當(dāng)選擇系統(tǒng)自動(dòng)創(chuàng)建VPC時(shí),默認(rèn)使用172.19.0.0/20網(wǎng)段。 |
snat_entry | Boolean | 否 | true | 是否為網(wǎng)絡(luò)配置SNAT:
如果您的應(yīng)用需要訪問公網(wǎng),建議配置為 默認(rèn)值: |
ssh_flags | Boolean | 否 | true | 是否開放公網(wǎng)SSH登錄。取值:
默認(rèn)值: |
tags | Array | 否 | 集群標(biāo)簽。 | |
Key | String | 否 | env | 標(biāo)簽key-value的鍵。 |
value | String | 否 | prod | 標(biāo)簽key-value的值。 |
tains | Array | 否 | 節(jié)點(diǎn)污點(diǎn)信息。污點(diǎn)和容忍度(Toleration)相互配合,可以用來避免Pod被分配到不合適的節(jié)點(diǎn)上。更多信息,請(qǐng)參見taint-and-toleration。 | |
effect | String | 否 | NoSchedule | 調(diào)度策略。取值:
|
Key | String | 否 | disk_type | 污點(diǎn)key-value的鍵。 |
value | String | 否 | sshd | 污點(diǎn)key-value的值。 |
timeout_mins | Long | 否 | 60 | 集群創(chuàng)建超時(shí)時(shí)間。單位:分鐘。 默認(rèn)值:60。 |
user_data | String | 否 | IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFD**** | 節(jié)點(diǎn)自定義數(shù)據(jù)。更多信息,請(qǐng)參見ECS實(shí)例自定義數(shù)據(jù)概述。 |
vpcid | String | 是 | vpc-2zeik9h3ahvv2zz95**** | 集群使用的VPC實(shí)例ID。 |
vswitch_ids | Array of String | 是 | ["vsw-2ze48rkq464rsdts1****"] | 虛擬交換實(shí)例ID。 |
worker_auto_renew | Boolean | 否 | true | Worker節(jié)點(diǎn)是否開啟自動(dòng)續(xù)費(fèi),當(dāng)
默認(rèn)值: |
worker_auto_renew_period | Long | 否 | 1 | Worker節(jié)點(diǎn)自動(dòng)續(xù)費(fèi)周期,當(dāng)選擇包年包月付費(fèi)類型時(shí)才生效,且為必選值。取值范圍:{1,2,3,6,12}。 |
worker_data_disks | Array | 是 | Worker節(jié)點(diǎn)數(shù)據(jù)盤類型、大小等配置的組合。 | |
auto_snapshot_policy_id | String | 否 | sp-bp14j6w7ss6ozz**** | 自動(dòng)快照策略ID。 |
category | String | 否 | cloud_ssd | Worker節(jié)點(diǎn)數(shù)據(jù)盤類型,取值:
默認(rèn)值: |
encrypted | String | 否 | false | 是否對(duì)數(shù)據(jù)盤加密。取值:
默認(rèn)值: |
size | String | 是 | 200 | 數(shù)據(jù)盤大小,內(nèi)存單位為GiB。取值:
說明 安全沙箱節(jié)點(diǎn)要求至少有一塊不小于200 GiB的數(shù)據(jù)盤。 |
worker_instance_charge_type | String | 是 | PrePaid | Worker節(jié)點(diǎn)付費(fèi)類型,取值:
默認(rèn):按量付費(fèi)。 |
worker_instance_types | Array of String | 是 | ["ecs.ebmg5s.24xlarge"] | Worker節(jié)點(diǎn)實(shí)例類型。 重要 安全沙箱集群只支持神龍裸金屬實(shí)例。 |
worker_period | Long | 否 | 1 | Worker節(jié)點(diǎn)包年包月時(shí)長(zhǎng),當(dāng) 默認(rèn)值:1。 |
worker_period_unit | String | 否 | Month | Worker節(jié)點(diǎn)付費(fèi)周期,當(dāng)付費(fèi)類型為 |
worker_system_disk_category | String | 否 | cloud_efficiency | Worker節(jié)點(diǎn)系統(tǒng)盤類型,取值:
默認(rèn)值: |
worker_system_disk_size | Long | 否 | 200 | Worker節(jié)點(diǎn)系統(tǒng)盤大小,單位為GiB。 取值范圍:[40,500]。 該參數(shù)的取值必須大于或者等于max{40, ImageSize}。 默認(rèn)值: |
worker_vswitch_ids | Array of String | 否 | ["vsw-2ze3ds0mdip0hdz8i****"] | 集群節(jié)點(diǎn)使用的虛擬交換機(jī)列表,一個(gè)節(jié)點(diǎn)對(duì)應(yīng)一個(gè)值。 |
zone_id | String | 否 | cn-beijing-b | 集群所屬地域的可用區(qū)ID。 |
resource_group_id | String | 否 | rg-acfm3mkrure**** | 集群所屬資源組ID,實(shí)現(xiàn)不同資源的隔離。 |
響應(yīng)體語法
HTTP/1.1 200
Content-Type:application/json
{
"cluster_id" : "String",
"request_id" : "String",
"task_id" : "String"
}
響應(yīng)參數(shù)
表 2. 響應(yīng)Body參數(shù)
名稱 | 類型 | 示例值 | 描述 |
cluster_id | String | cb95aa626a47740afbf6aa099b650**** | 集群ID。 |
request_id | String | 687C5BAA-D103-4993-884B-C35E4314A1E1 | 請(qǐng)求ID。 |
task_id | String | T-5a54309c80282e39ea00002f | 任務(wù)ID。 |
示例1 使用Flannel網(wǎng)絡(luò)插件創(chuàng)建ACK專有版安全沙箱集群
請(qǐng)求示例
POST /clusters
公共請(qǐng)求頭
{
"cluster_type": "Kubernetes",
"name": "webService",
"region_id": "cn-hangzhou",
"disable_rollback": true,
"timeout_mins": 60,
"kubernetes_version": "1.18.8-aliyun.1",
"snat_entry": true,
"endpoint_public_access": false,
"cloud_monitor_flags": true,
"deletion_protection": false,
"node_cidr_mask": "26",
"proxy_mode": "ipvs",
"timezone": "Asia/Shanghai",
"tags": [],
"addons": [{
"name": "flannel"
}, {
"name": "arms-prometheus"
}, {
"name": "csi-plugin"
}, {
"name": "csi-provisioner"
}, {
"name": "logtail-ds",
"config": "{\"IngressDashboardEnabled\":\"true\"}"
}, {
"name": "ack-node-problem-detector",
"config": "{\"sls_project_name\":\"\"}"
}, {
"name": "nginx-ingress-controller",
"config": "{\"IngressSlbNetworkType\":\"internet\"}"
}],
"node_port_range": "30000-32767",
"login_password": "Hello1234!",
"cpu_policy": "none",
"master_count": 3,
"master_vswitch_ids": ["vsw-bp1hl2o4i9z7sbmy*****", "vsw-bp1hl2o4i9z7sbmy*****", "vsw-bp1hl2o4i9z7sbmy*****"],
"master_instance_types": ["ecs.c6e.large", "ecs.c6e.large", "ecs.c6e.large"],
"master_system_disk_category": "cloud_essd",
"master_system_disk_size": 120,
"runtime": {
"name": "Sandboxed-Container.runv",
"version": "2.1.0"
},
"worker_instance_types": ["ecs.ebmc5s.24xlarge"],
"num_of_nodes": 1,
"worker_system_disk_category": "cloud_essd",
"worker_system_disk_size": 120,
"worker_data_disks": [{
"category": "cloud_efficiency",
"size": "200",
"encrypted": "false",
"auto_snapshot_policy_id": ""
}],
"vpcid": "vpc-bp1gxh70jnkl12vq*****",
"worker_vswitch_ids": ["vsw-bp1hl2o4i9z7sbmy*****"],
"is_enterprise_security_group": true,
"container_cidr": "172.23.0.0/16",
"service_cidr": "172.21.0.0/20"
}
正常返回示例
XML
格式
<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>
JSON
格式
{
"cluster_id": "cb95aa626a47740afbf6aa099b650****",
"task_id": "T-5a54309c80282e39ea00002f",
"request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}
示例2 使用Terway網(wǎng)絡(luò)插件創(chuàng)建專有版安全沙箱集群示例
如果您創(chuàng)建是Terway網(wǎng)絡(luò)類型的集群,pod_vswitch_ids
為必填參數(shù)。
請(qǐng)求示例
POST /clusters HTTP/1.1
公共請(qǐng)求頭
{
"cluster_type":"Kubernetes",
"name":"webService-terway",
"region_id":"cn-beijing",
"disable_rollback":true,
"timeout_mins":60,
"kubernetes_version":"1.14.8-aliyun.1",
"snat_entry":true,
"endpoint_public_access":true,
"ssh_flags":true,"cloud_monitor_flags":true,
"deletion_protection":false,
"proxy_mode":"ipvs",
"tags":[],
"addons":[{"name":"terway-eni"},{"name":"flexvolume"},{"name":"alicloud-disk-controller"},{"name":"logtail-ds","config":"{\"IngressDashboardEnabled\":\"false\"}"},{"name":"ack-node-problem-detector","config":"{\"sls_project_name\":\"\"}"},{"name":"nginx-ingress-controller","config":"{\"IngressSlbNetworkType\":\"internet\"}"}],
"os_type":"Linux",
"platform":"CentOS",
"node_port_range":"30000-32767",
"pod_vswitch_ids":["vsw-2zete8s4qocqg0mf6****"],
"key_pair":"sian-sshkey",
"cpu_policy":"none",
"master_count":3,
"master_vswitch_ids":["vsw-2zed90q9inwtuyfzd****","vsw-2zed90q9inwtuyfzd****","vsw-2zed90q9inwtuyfzd****"],
"master_instance_types":["ecs.i1.4xlarge","ecs.i1.4xlarge","ecs.i1.4xlarge"],
"master_system_disk_category":"cloud_ssd",
"master_system_disk_size":120,
"runtime":{"name":"docker","version":"18.09.2"},
"worker_instance_types":["ecs.i1.4xlarge"],
"num_of_nodes":1,
"worker_system_disk_category":"cloud_efficiency",
"worker_system_disk_size":120,
"vpcid":"vpc-2zecuu62b9zw7a7qnn2tv",
"worker_vswitch_ids":["vsw-2zed90q9inwtuyfzd****"],
"is_enterprise_security_group":true,
"service_cidr":"172.21.0.0/20"
}
正常返回示例
XML
格式
<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>
JSON
格式
{
"cluster_id": "cb95aa626a47740afbf6aa099b650****",
"task_id": "T-5a54309c80282e39ea00002f",
"request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
開發(fā)者資源
阿里云為您提供多種語言的SDK,幫助您快速通過API集成阿里云的產(chǎn)品和服務(wù),推薦您使用SDK調(diào)用API,以免除您手動(dòng)簽名驗(yàn)證,詳情請(qǐng)參見SDK參考文檔鏈接。
快速檢索,可視化調(diào)試API,在線命令行工具,同步動(dòng)態(tài)生成可執(zhí)行的SDK代碼示例。
阿里云資產(chǎn)管理和配置工具,可通過命令方式同時(shí)管理多個(gè)阿里云產(chǎn)品和服務(wù),簡(jiǎn)單快捷,是您上云好幫手。