調用CreateCluster創建一個新的ACK Edge集群。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求語法
POST /clusters HTTP/1.1
Content-Type:application/json
{
"name" : "String",
"cluster_type" : "String",
"disable_rollback" : Boolean,
"timeout_mins" : Long,
"kubernetes_version" : "String",
"runtime" : {
"name" : "String",
"version" : "String"
},
"region_id" : "String",
"key_pair" : "String",
"login_password" : "String",
"num_of_nodes" : Long,
"profile" : "String",
"logging_type" : "String",
"snat_entry" : Boolean,
"vswitch_ids" : [ "String" ],
"worker_system_disk_category" : "String",
"worker_system_disk_size" : Long,
"container_cidr" : "String",
"cloud_monitor_flags" : Boolean,
"endpoint_public_access" : Boolean,
"service_cidr" : "String",
"addons" : [ {
"name" : "String",
"config" : "String",
"disabled" : Boolean
} ],
"tags" : [ {
"key" : "String",
"value" : "String"
} ],
"vpcid" : "String",
"worker_data_disks" : [ {
"category" : "String",
"size" : Long,
"encrypted" : "String",
"auto_snapshot_policy_id" : "String"
} ],
"deletion_protection" : Boolean,
"node_cidr_mask" : "String",
"worker_instance_types" : [ "String" ],
"worker_instance_charge_type" : "String",
"security_group_id" : "String",
"is_enterprise_security_group" : Boolean,
"rds_instances" : [ "String" ]
}
請求參數
表 1. 請求Body參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
name | String | 是 | demo-edge-cluster | 集群名稱。 命名規則:由數字、漢字、英文字符或短劃線(-)組成,長度范圍1~63個字符,且不能以短劃線(-)開頭。 |
cluster_type | String | 是 | ManagedKubernetes | 集群類型。取值 |
disable_rollback | Boolean | 否 | true | 集群創建失敗是否回滾。取值:
默認值: |
timeout_mins | Long | 否 | 60 | 集群資源棧創建超時時間,以分鐘為單位,默認值60分鐘。 |
kubernetes_version | String | 否 | 1.30.1-aliyun.1 | 集群版本,與Kubernetes社區基線版本保持一致。建議選擇最新版本,若不指定,默認使用最新版本。 目前您可以在ACK控制臺創建兩種最新版本的集群。您可以通過API創建其他Kubernetes版本集群。關于ACK支持的Kubernetes版本,請參見Kubernetes版本概覽及機制。 |
runtime | Array of runtime | 否 | {"name": " | 容器運行時,支持 包括以下信息:
|
region_id | String | 是 | cn-beijing | 集群所在地域ID。 |
key_pair | String | 是 | demo-key | 密鑰對名稱,和 |
login_password | String | 是 | HelloWorld123 | SSH登錄密碼,和 |
num_of_nodes | Long | 是 | 1 | Worker節點數。范圍是[0,100]。 |
profile | String | 是 | Edge | ACK Edge集群標識,默認取值:Edge。 |
logging_type | String | 否 | SLS | 集群開啟日志服務,只針對ACK Serverless集群生效,且取值必須是 |
snat_entry | Boolean | 否 | true | 是否為網絡配置SNAT:
如果您的應用需要訪問公網,建議配置為 默認值: |
vswitch_ids | Array of String | 是 | vsw-2ze48rkq464rsdts1**** | 交換機ID。List長度范圍為[1,3]。 |
worker_system_disk_category | String | 是 | cloud_efficiency | Worker節點系統盤類型,取值:
默認值: |
worker_system_disk_size | Long | 是 | 100 | Worker節點系統盤大小,單位為GiB。 取值范圍:[40,500]。 該參數的取值必須大于或者等于max{40, ImageSize}。 默認值: |
container_cidr | String | 否 | 172.20.0.0 | Pod網絡地址段,不能和VPC網段沖突。當選擇系統自動創建VPC時,默認使用172.16.0.0/16網段。 重要
|
cloud_monitor_flags | Boolean | 否 | true | 集群是否安裝云監控插件。取值:
默認值: |
endpoint_public_access | Boolean | 否 | true | 是否開啟公網API Server。取值:
默認值: 重要 在ACK Edge集群場景,邊緣節點通過公網和云端管控交互;因此,ACK Edge集群需要開啟公網訪問。 |
service_cidr | String | 是 | 172.21.0.0 | Service網絡地址段,不能和VPC網段及Pod網絡網段沖突。當選擇系統自動創建VPC時,默認使用172.19.0.0/20網段。 |
addons | Array of addon | 否 | [{"name":"flannel","config":""},{"name":"logtail-ds-docker","config":""},{"name":"alibaba-log-controller","config":"{"IngressDashboardEnabled":"false"}"}] | Kubernetes集群安裝的組件列表。組件的結構包括:
網絡組件:必選,包含Flannel和Terway兩種網絡類型,創建集群時二選一:
存儲組件:可選,支持
日志組件:可選。 說明 如果不開啟日志服務,則無法使用集群審計功能。
Ingress組件:可選,ACK專有版集群默認安裝Ingress組件nginx-ingress-controller。
事件中心:可選,默認開啟。事件中心提供對Kubernetes事件的存儲、查詢、告警等能力。Kubernetes事件中心關聯的Logstore在90天內免費。關于免費策略的更多信息,請參見創建并使用K8s事件中心。 開啟事件中心:[{"name":"ack-node-problem-detector","config":"{\"sls_project_name\":\" your_sls_project_name\"}"}]。 |
tags | Array of tag | 否 | [{"key": "env", "value": "prod"}] | 給集群打tag標簽:
|
vpcid | String | 是 | vpc-2zeik9h3ahvv2zz95**** | 集群使用的專有網絡,創建集群時必須為集群提供。 說明
|
worker_data_disks | Array of data_disk | 否 | Worker節點數據盤類型、大小等配置的組合。 | |
deletion_protection | Boolean | 否 | true | 集群刪除保護,防止通過控制臺或API誤刪除集群。取值:
默認值: |
node_cidr_mask | String | 否 | 25 | 節點IP數量,通過指定網絡的CIDR來確定IP的數量,只對于Flannel網絡類型集群生效。 默認值: |
worker_instance_types | Array of String | 是 | ecs.n4.large | Worker節點實例規格,至少要指定一個實例規格。更多信息,請參見實例規格族。 說明 實例規格優先級隨著在數據中的位置增大而依次降低。當無法根據優先級較高的實例規格創建出實例時,會自動選擇下一優先級的實例規格來創建實例。 |
worker_instance_charge_type | String | 是 | PrePaid | Worker節點付費類型,取值:
默認值:按量付費。 |
security_group_id | String | 否 | sg-bp1bdue0qc1g7k**** | 使用已有安全組創建集群時需要指定安全組ID,和 |
is_enterprise_security_group | Boolean | 否 | true | 自動創建企業級安全組,當 說明 使用普通安全組時,集群內節點與Terway Pod數量之和不能超過2000。所以創建Terway網絡類型集群時,建議使用企業安全組。
默認值: |
rds_instances | rds_instances | 否 | rm-2zev748xi27xc**** | RDS實例名稱。 |
cluster_spec | String | 否 | ack.pro.small | 托管版集群類型,面向托管集群。取值:
默認值: 更多信息,請參見ACK Edge集群Pro版介紹。 |
resource_group_id | String | 否 | rg-acfm3mkrure**** | 集群所屬資源組ID,實現不同資源的隔離。 |
響應體語法
HTTP/1.1 200
Content-Type:application/json
{
"cluster_id" : "String",
"request_id" : "String",
"task_id" : "String"
}
響應參數
表 2. 響應Body參數
名稱 | 類型 | 示例值 | 描述 |
cluster_id | String | cb95aa626a47740afbf6aa099b650**** | 集群ID。 |
request_id | String | 687C5BAA-D103-4993-884B-C35E4314A1E1 | 請求ID。 |
task_id | String | T-5a54309c80282e39ea00002f | 任務ID。 |
創建ACK邊緣托管版集群示例
請求示例
POST /clusters
<公共請求頭>
{
"name":"ACK邊緣托管版",
"cluster_type":"ManagedKubernetes",
"disable_rollback":true,
"timeout_mins":60,
"kubernetes_version":"1.14.8-aliyunedge.1",
"region_id":"cn-zhangjiakou",
"snat_entry":true,
"cloud_monitor_flags":true,
"endpoint_public_access":true,
"deletion_protection":true,
"node_cidr_mask":"25",
"tags":[
{
"key":"tag-k",
"value":"tag-v"
}
],
"addons":[
{
"name":"logtail-ds-docker"
},
{
"name":"alibaba-log-controller",
"config":"{\"IngressDashboardEnabled\":\"false\"}"
},
{
"name":"flannel"
},
{
"name":"alicloud-monitor-controller"
}
],
"profile":"Edge", // 邊緣集群標識。
"logging_type" : "SLS",
"worker_instance_types":[
"ecs.hfc6.large"
],
"runtime":{ // 容器運行時。
"name":"containerd", // 運行時名稱。
"version":"1.6.20" // 運行時版本。
},
"num_of_nodes":1,
"worker_system_disk_category":"cloud_ssd",
"worker_system_disk_size":40,
"worker_data_disks":[
{
"category":"cloud_efficiency",
"size":"40",
"encrypted":"false",
"auto_snapshot_policy_id":"",
}
],
"worker_instance_charge_type":"PostPaid",
"vpcid":"vpc-8vb435kr467tnfj42****",
"container_cidr":"172.20.0.0/16",
"service_cidr":"172.21.0.0/20",
"vswitch_ids":[
"vsw-8vbhdhn461i65p32g****"
],
"login_password":"Hello1234",
"key_pair": "sin-name",
"security_group_id":"sg-8vb7grbyvlb10j0i****",
"is_enterprise_security_group":true,
"rds_instances": ["rm-xx","rm-xx"]
}
正常返回示例
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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
開發者資源
阿里云為您提供多種語言的SDK,幫助您快速通過API集成阿里云的產品和服務,推薦您使用SDK調用API,以免除您手動簽名驗證,詳情請參見SDK參考文檔鏈接。
快速檢索,可視化調試API,在線命令行工具,同步動態生成可執行的SDK代碼示例。
阿里云資產管理和配置工具,可通過命令方式同時管理多個阿里云產品和服務,簡單快捷,是您上云好幫手。