Buat klaster ACK Edge dengan memanggil operasi API - Container Service for Kubernetes

Anda dapat menggunakan operasi CreateCluster untuk membuat Container Service for Kubernetes (ACK) Edge cluster.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai tanda tangan. Untuk kemudahan penggunaan, Anda disarankan memanggil operasi ini melalui OpenAPI Explorer. Alat ini juga menghasilkan contoh kode operasi untuk berbagai SDK secara dinamis.

Sintaks permintaan

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" ]
}

Parameter permintaan

Tabel 1. Parameter Body Permintaan

Parameter	Tipe	Diperlukan	Contoh	Deskripsi
name	String	Ya	demo-edge-cluster	Nama klaster. Nama harus memiliki panjang 1 hingga 63 karakter, dan dapat berisi angka, huruf, dan tanda hubung (-). Nama tidak boleh dimulai dengan tanda hubung (-).
cluster_type	String	Ya	ManagedKubernetes	Tipe klaster. Atur nilainya menjadi `ManagedKubernetes` untuk membuat klaster ACK Edge.
disable_rollback	Boolean	Tidak	true	Parameter ini sudah tidak digunakan lagi. Menentukan apakah akan melakukan rollback saat klaster gagal dibuat. Nilai yang valid: `true`: melakukan rollback saat klaster gagal dibuat. `false`: tidak melakukan rollback saat klaster gagal dibuat. Nilai default: `false`.
timeout_mins	Long	Tidak	60	Parameter ini sudah tidak digunakan lagi. Jangka waktu timeout selama sumber daya harus dibuat. Unit: menit. Nilai default: 60.
kubernetes_version	String	Tidak	1.30.1-aliyun.1	Versi Kubernetes dari klaster. Versi Kubernetes yang didukung oleh Container Service sama dengan versi Kubernetes yang didukung oleh open source Kubernetes. Kami merekomendasikan Anda menentukan versi Kubernetes terbaru. Jika Anda tidak menyetel parameter ini, versi Kubernetes terbaru akan digunakan. Anda dapat membuat klaster dari tiga versi Kubernetes terbaru di konsol ACK. Anda dapat membuat klaster dari versi Kubernetes sebelumnya dengan memanggil operasi API. Untuk informasi lebih lanjut tentang versi Kubernetes yang didukung oleh ACK, lihat Versi Kubernetes yang didukung.
runtime	Array of runtime	Tidak	{"name": "`containerd`", "version": "1.6.20"}	Runtime kontainer yang ingin Anda gunakan. Runtime `containerd` dan `docker` didukung. Parameter ini menentukan informasi berikut: `name`: nama runtime kontainer. `version`: versi runtime kontainer.
region_id	String	Ya	cn-beijing	ID wilayah klaster.
key_pair	String	Ya	demo-key	Parameter ini sudah tidak digunakan lagi. Nama pasangan kunci. Anda harus menyetel parameter ini atau `login_password`.
login_password	String	Ya	HelloWorld123	Parameter ini sudah tidak digunakan lagi. Kata sandi untuk logon SSH. Anda harus menyetel parameter ini atau `key_pair`. Kata sandi harus memiliki panjang 8 hingga 30 karakter, dan harus berisi setidaknya tiga dari jenis karakter berikut: huruf besar, huruf kecil, angka, dan karakter khusus.
num_of_nodes	Long	Ya	1	Parameter ini sudah tidak digunakan lagi. Jumlah node pekerja. Nilai valid: 0 hingga 100.
profile	String	Ya	Edge	Menentukan apakah klaster adalah ACK Edge cluster. Nilai default: Edge.
logging_type	String	Tidak	SLS	Menentukan apakah akan mengaktifkan Simple Log Service untuk klaster. Atur nilainya menjadi `SLS`. Parameter ini hanya berlaku untuk klaster ACK Serverless.
snat_entry	Boolean	Tidak	true	Menentukan apakah akan mengonfigurasi aturan SNAT untuk virtual private cloud (VPC) tempat Anda ingin menerapkan klaster. Jika VPC dapat mengakses Internet, atur nilainya menjadi `false`. Jika VPC tidak menyediakan akses ke Internet, nilai-nilai berikut valid: `true`: mengonfigurasi aturan SNAT. Ini memungkinkan klaster mengakses Internet dari VPC. `false`: tidak mengonfigurasi aturan SNAT. Dalam hal ini, klaster tidak dapat mengakses Internet. Jika aplikasi yang diterapkan di klaster perlu mengakses Internet, kami sarankan Anda mengatur nilainya menjadi `true`. Nilai default: `false`.
vswitch_ids	Array of String	Ya	vsw-2ze48rkq464rsdts1****	ID vSwitches. Anda dapat menentukan satu hingga tiga vSwitches.
worker_system_disk_category	String	Ya	cloud_efficiency	Parameter ini sudah tidak digunakan lagi. Tipe disk sistem yang ingin Anda gunakan untuk node pekerja. Nilai valid: `cloud_efficiency`: ultra disk. `cloud_ssd`: SSD standar. Nilai default: `cloud_ssd`.
worker_system_disk_size	Long	Ya	100	Parameter ini sudah tidak digunakan lagi. Ukuran disk sistem yang ingin Anda gunakan untuk node pekerja. Unit: GiB. Nilai valid: 40 hingga 500 Nilai parameter ini harus minimal 40 dan tidak kurang dari ukuran gambar. Nilai default: `120`.
container_cidr	String	Tidak	172.20.0.0	CIDR block pod. CIDR block ini tidak boleh tumpang tindih dengan CIDR block VPC tempat klaster diterapkan. Jika VPC dibuat secara otomatis oleh sistem, CIDR block pod default adalah 172.16.0.0/16. Penting Parameter ini diperlukan jika klaster menggunakan Flannel sebagai plug-in jaringan. Parameter ini opsional jika klaster menggunakan Terway sebagai plug-in jaringan.
cloud_monitor_flags	Boolean	Tidak	true	Parameter ini sudah tidak digunakan lagi. Menentukan apakah akan menginstal agen CloudMonitor. Nilai valid: `true`: menginstal agen CloudMonitor. `false`: tidak menginstal agen CloudMonitor. Nilai default: `false`.
endpoint_public_access	Boolean	Tidak	true	Menentukan apakah akan mengaktifkan akses Internet untuk server API. Nilai valid: `true`: mengaktifkan akses Internet untuk server API. `false`: menonaktifkan akses Internet untuk server API. Server API hanya dapat diakses dalam jaringan internal. Nilai default: `true`. Penting Dalam klaster ACK Edge, node tepi berinteraksi dengan bidang kontrol di cloud melalui Internet. Oleh karena itu, Anda harus mengaktifkan akses Internet untuk server API saat membuat klaster ACK Edge.
service_cidr	String	Ya	172.21.0.0	CIDR block Layanan. CIDR block ini tidak boleh tumpang tindih dengan CIDR block pod atau CIDR block VPC tempat Anda ingin menerapkan klaster. Jika VPC dibuat secara otomatis oleh sistem, CIDR block Layanan default adalah 172.19.0.0/20.
addons	Array of addon	Tidak	[{"name":"flannel","config":""},{"name":"logtail-ds-docker","config":""},{"name":"alibaba-log-controller","config":"{"IngressDashboardEnabled":"false"}"}]	Komponen yang ingin Anda instal di klaster. Deskripsi parameter: `name`: wajib. Parameter ini menentukan nama komponen. `config`: opsional. Jika parameter ini dibiarkan kosong, tidak diperlukan konfigurasi. `disabled`: opsional. Parameter ini menentukan apakah akan menonaktifkan instalasi otomatis. Plug-in jaringan: wajib. Plug-in jaringan yang didukung adalah Flannel dan Terway. Pilih salah satu plug-in untuk klaster. Tentukan plug-in Flannel dalam format berikut: [{"name":"flannel","config":""}]. Tentukan plug-in Terway dalam format berikut: [{"name": "terway-eniip","config": ""}]. Plug-in volume: opsional. Parameter ini menentukan plug-in volume yang ingin Anda gunakan. Plug-in `Container Storage Interface (CSI)` didukung. Tentukan plug-in `CSI` dalam format berikut: [{"name":"csi-plugin","config": ""},{"name": "csi-provisioner","config": ""}]. Komponen Layanan Log: opsional. Catatan Jika Simple Log Service dinonaktifkan, Anda tidak dapat menggunakan fitur audit klaster. Untuk menggunakan proyek Simple Log Service yang ada, tentukan komponen dalam format berikut: [{"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\",\"sls_project_name\":\"your_sls_project_name\"}"}]. Untuk membuat proyek Simple Log Service, tentukan komponen dalam format berikut: [{"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\"}"}]. Kontroler Ingress: opsional. Secara default, komponen nginx-ingress-controller diinstal di klaster ACK khusus. Untuk menginstal nginx-ingress-controller dan mengaktifkan akses Internet, tentukan kontroler Ingress dalam format berikut: [{"name":"nginx-ingress-controller","config":"{\"IngressSlbNetworkType\":\"internet\"}"}]. Jika Anda tidak ingin menginstal nginx-ingress-controller, tentukan kontroler Ingress dalam format berikut: [{"name": "nginx-ingress-controller","config": "","disabled": true}]. Pusat acara: opsional. Secara default, fitur pusat acara diaktifkan. Anda dapat menggunakan pusat acara untuk menyimpan dan mencari acara, serta mengonfigurasi aturan peringatan. Anda dapat menggunakan Logstore yang terkait dengan pusat acara secara gratis selama 90 hari. Untuk informasi lebih lanjut, lihat Buat dan gunakan pusat acara. Untuk mengaktifkan fitur pusat acara, tentukan komponen dalam format berikut: [{"name":"ack-node-problem-detector","config":"{\"sls_project_name\":\" your_sls_project_name\"}"}].
tags	Array of tag	Tidak	[{"key": "env", "value": "prod"}]	Label yang ingin Anda tambahkan ke klaster. key: kunci label. value: nilai label.
vpcid	String	Ya	vpc-2zeik9h3ahvv2zz95****	VPC tempat Anda ingin menerapkan klaster. Anda harus menentukan VPC saat membuat klaster. Catatan Biarkan kedua `vpc_id` dan `vswitch_ids` kosong atau pastikan bahwa vSwitches yang ditentukan oleh parameter vswitch_ids termasuk dalam VPC yang ditentukan oleh parameter vpc_id.
worker_data_disks	Array of data_disk	Tidak		Parameter ini sudah tidak digunakan lagi. Konfigurasi disk data yang dipasang ke node pekerja. Konfigurasi mencakup tipe disk dan ukuran disk.
deletion_protection	Boolean	Tidak	true	Menentukan apakah akan mengaktifkan perlindungan penghapusan untuk klaster. Jika perlindungan penghapusan diaktifkan, klaster tidak dapat dihapus di konsol ACK atau dengan memanggil operasi API. Nilai valid: `true`: mengaktifkan perlindungan penghapusan untuk klaster. Dengan cara ini, klaster tidak dapat dihapus di konsol ACK atau dengan memanggil operasi API. `false`: menonaktifkan perlindungan penghapusan untuk klaster. Dengan cara ini, klaster dapat dihapus di konsol ACK atau dengan memanggil operasi API. Nilai default: `false`.
node_cidr_mask	String	Tidak	25	Jumlah maksimum alamat IP yang dapat ditetapkan ke setiap node. Angka ini ditentukan oleh blok pod CIDR yang ditentukan. Parameter ini hanya berlaku jika klaster menggunakan plug-in Flannel. Nilai default: `25`.
worker_instance_types	Array of String	Ya	ecs.n4.large	Parameter ini sudah tidak digunakan lagi. Tipe instance Elastic Compute Service (ECS) dari node pekerja. Anda harus menentukan setidaknya satu tipe instance. Untuk informasi lebih lanjut, lihat Ikhtisar keluarga instance. Catatan Tipe instance terdaftar dalam urutan prioritas menurun. Jika sistem gagal membuat node pekerja dengan tipe instance prioritas tertinggi, sistem akan mencoba membuat node pekerja dengan tipe instance prioritas tertinggi berikutnya.
worker_instance_charge_type	String	Ya	PrePaid	Parameter ini sudah tidak digunakan lagi. Metode penagihan node pekerja. Nilai valid: `PrePaid`: langganan. `PostPaid`: bayar sesuai pemakaian. Nilai default: PostPaid.
security_group_id	String	Tidak	sg-bp1bdue0qc1g7k****	ID kelompok keamanan yang ada yang ingin Anda gunakan untuk klaster. Anda harus menyetel parameter ini atau `is_enterprise_security_group`. Node dalam klaster secara otomatis ditambahkan ke kelompok keamanan yang ditentukan.
is_enterprise_security_group	Boolean	Tidak	true	Menentukan apakah akan membuat kelompok keamanan tingkat lanjut. Parameter ini hanya berlaku jika `security_group_id` dibiarkan kosong. Catatan Untuk menggunakan kelompok keamanan dasar, pastikan bahwa jumlah node dalam klaster dan jumlah pod yang menggunakan Terway tidak melebihi 2.000. Oleh karena itu, jika klaster menggunakan plug-in jaringan Terway, kami sarankan Anda menentukan kelompok keamanan tingkat lanjut untuk klaster. `true`: membuat kelompok keamanan tingkat lanjut. `false`: tidak membuat kelompok keamanan tingkat lanjut. Nilai default: `true`.
rds_instances	rds_instances	Tidak	rm-2zev748xi27xc****	Parameter ini sudah tidak digunakan lagi. Nama instance ApsaraDB RDS.
cluster_spec	String	Tidak	ack.pro.small	Tipe klaster ACK managed. Nilai valid: `ack.pro.small`: ACK Edge Pro cluster. `ack.standard`: ACK Edge Basic cluster. Nilai default: `ack.standard`. Jika Anda meninggalkan parameter ini kosong, klaster ACK Edge Basic dibuat. Untuk informasi lebih lanjut, lihat pengantar tentang klaster ACK Edge Pro.
resource_group_id	String	Tidak	rg-acfm3mkrure****	ID grup sumber daya tempat klaster milik. Anda dapat menggunakan parameter ini untuk mengisolasi klaster yang berbeda.

Sintaks respons

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "request_id" : "String",
  "task_id" : "String"
}

Parameter respons

Tabel 2. Parameter Body Respons

Parameter	Tipe	Contoh	Deskripsi
cluster_id	String	cb95aa626a47740afbf6aa099b650****	ID klaster.
request_id	String	687C5BAA-D103-4993-884B-C35E4314A1E1	ID permintaan.
task_id	String	T-5a54309c80282e39ea00002f	ID tugas.

Contoh

Contoh Permintaan

POST /clusters 
<Common request headers>
{
    "name":"ACK Edge cluster",
    "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",            // Menentukan bahwa klaster adalah klaster ACK Edge. 
    "logging_type" : "SLS",
    "worker_instance_types":[
        "ecs.hfc6.large"
    ],
    "runtime":{                       // Konfigurasi runtime kontainer. 
        "name":"containerd",              // Nama runtime kontainer. 
        "version":"1.6.20"          // Versi runtime kontainer. 
    },
    "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"]
}

Contoh Respons Sukses

XML Format

<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>

JSON Format

{
    "cluster_id": "cb95aa626a47740afbf6aa099b650****",
    "task_id": "T-5a54309c80282e39ea00002f",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode Kesalahan Layanan.