Gunakan CreateServerGroup API untuk membuat grup server GWLB - Server Load Balancer

Membuat grup server load balancing.

Deskripsi operasi

API CreateServerGroup bersifat asinkron. Setelah Anda memanggil API ini, sistem akan mengembalikan Request ID dan mulai membuat Server Group di latar belakang. Anda dapat memanggil API ListServerGroups untuk mengecek status pembuatan Server Group tersebut:

Status Creating menunjukkan bahwa Server Group sedang dalam proses pembuatan.
Status Available menunjukkan bahwa Server Group telah berhasil dibuat.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

gwlb:CreateServerGroup

create

*ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/*

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ServerGroupType	string	No	Jenis grup server. Nilai yang valid: Instance (default): Grup server berbasis instans. Anda dapat menambahkan instans ECS, ENI, dan ECI ke jenis grup server ini. Ip: Grup server berbasis IP. Anda dapat menambahkan server backend ke jenis grup server ini dengan menentukan alamat IP-nya.	Instance
ServerGroupName	string	No	Nama grup server. Nama harus terdiri dari 2 hingga 128 karakter, dimulai dengan huruf atau karakter Tionghoa, serta dapat berisi angka, titik (.), garis bawah (_), dan tanda hubung (-).	testServerGroupName
Protocol	string	No	Protokol yang digunakan oleh server backend. Nilai yang valid: GENEVE (default). Valid values: GENEVE : GENEVE	GENEVE
Scheduler	string	No	Algoritma penjadwalan. Nilai yang valid: 5TCH (default): hash konsisten berdasarkan 5-tuple (IP sumber, IP tujuan, port sumber, port tujuan, dan protokol). Aliran dengan 5-tuple yang sama akan diarahkan ke server backend yang sama. 3TCH: hash konsisten berdasarkan 3-tuple (IP sumber, IP tujuan, dan protokol). Aliran dengan 3-tuple yang sama akan diarahkan ke server backend yang sama. 2TCH: hash konsisten berdasarkan 2-tuple (IP sumber dan IP tujuan). Aliran dengan 2-tuple yang sama akan diarahkan ke server backend yang sama.	5TCH
ServerFailoverMode	string	No	Menentukan cara menangani koneksi yang ada ketika server backend menjadi tidak sehat. Nilai yang valid: NoRebalance (default): Tidak melakukan rebalance pada koneksi yang ada. Rebalance: Melakukan rebalance pada koneksi yang ada.	NoRebalance
VpcId	string	Yes	ID virtual private cloud (VPC). Catatan Jika ServerGroupType diatur ke Instance, hanya server dalam VPC ini yang dapat ditambahkan ke grup server.	vpc-bp15zckdt37pq72zv****
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-atstuj3rtop****
ConnectionDrainConfig	object	No	Konfigurasi pengurasan koneksi.
ConnectionDrainEnabled	boolean	No	Menentukan apakah pengurasan koneksi diaktifkan. Nilai yang valid: true: Diaktifkan. false (default): Dinonaktifkan.	false
ConnectionDrainTimeout	integer	No	Waktu tunggu untuk pengurasan koneksi. Unit: detik. Nilai yang valid: 1 hingga 3600. Nilai default: 300.	300
HealthCheckConfig	object	No	Konfigurasi pemeriksaan kesehatan.
HealthCheckConnectPort	integer	No	Port pada server backend yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: 1 hingga 65535. Nilai default: 80.	80
HealthCheckConnectTimeout	integer	No	Waktu tunggu maksimum untuk respons pemeriksaan kesehatan. Unit: detik. Nilai yang valid: 1 hingga 300. Nilai default: 5.	5
HealthCheckDomain	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: $SERVER_IP (default): alamat IP pribadi server backend. domain: nama domain kustom. Nama domain harus terdiri dari 1 hingga 80 karakter dan hanya boleh berisi huruf, angka, tanda hubung (-), dan titik (.). Catatan Parameter ini hanya berlaku ketika HealthCheckProtocol diatur ke HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	No	Menentukan apakah pemeriksaan kesehatan diaktifkan. Nilai yang valid: true (default): Diaktifkan. false: Dinonaktifkan.	true
HealthCheckHttpCode	array	No	Kode status HTTP yang menunjukkan server backend dalam kondisi sehat.
	string	No	Kode status HTTP yang menunjukkan pemeriksaan kesehatan berhasil. Anda dapat menentukan beberapa nilai, dipisahkan dengan koma. Nilai yang valid: http_2xx http_3xx http_4xx http_5xx Nilai default: http_2xx. Catatan Parameter ini hanya berlaku ketika HealthCheckProtocol diatur ke HTTP.	http_2xx
HealthCheckInterval	integer	No	Interval antar pemeriksaan kesehatan. Unit: detik. Nilai yang valid: 1 hingga 50. Nilai default: 10.	10
HealthCheckPath	string	No	Jalur yang digunakan untuk pemeriksaan kesehatan. Jalur harus terdiri dari 1 hingga 80 karakter, dimulai dengan garis miring (/), serta dapat berisi huruf, angka, dan karakter khusus berikut: `- / . % ? # & _;~!()[]@$^:',+=` Harus dimulai dengan garis miring (/). Catatan* Parameter ini hanya berlaku ketika HealthCheckProtocol diatur ke HTTP.	/test/index.html
HealthCheckProtocol	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: TCP (default): Sistem mengirim paket SYN ke server untuk memeriksa apakah port sedang mendengarkan. HTTP: Sistem mengirim permintaan GET ke server untuk memeriksa apakah aplikasi merespons.	TCP
HealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan berturut-turut yang berhasil yang diperlukan agar server backend dianggap sehat (setelah sebelumnya dianggap tidak sehat). Nilai yang valid: 2 hingga 10. Nilai default: 2.	2
UnhealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan berturut-turut yang gagal yang diperlukan agar server backend dianggap tidak sehat (setelah sebelumnya dianggap sehat). Nilai yang valid: 2 hingga 10. Nilai default: 2.	2
HealthCheckReq	string	No
HealthCheckExp	string	No
Tag	array<object>	No	Tag. Anda dapat menentukan hingga 20 tag dalam satu permintaan.
	object	No	Tag.
Key	string	No	Kunci tag. Tidak boleh berupa string kosong, panjang maksimal 128 karakter, dan tidak boleh diawali dengan `aliyun` atau `acs:`, serta tidak boleh mengandung `http://` atau `https://`.	testTagKey
Value	string	No	Nilai tag. Panjang maksimal 256 karakter dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: Melakukan dry run untuk memeriksa potensi masalah, termasuk parameter yang diperlukan, format permintaan, dan batas layanan. Permintaan tidak akan membuat grup server. Jika pemeriksaan gagal, pesan kesalahan akan dikembalikan. Jika pemeriksaan berhasil, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): Mengirim permintaan normal. Setelah permintaan lolos pemeriksaan, sistem akan mengembalikan kode status HTTP 2xx dan menjalankan operasi tersebut.	False
ClientToken	string	No	Token unik global yang dihasilkan klien untuk memastikan idempotensi permintaan. Anda dapat membuat token dari klien Anda, tetapi harus memastikan token tersebut unik di antara permintaan yang berbeda. Token klien hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId untuk setiap permintaan API bersifat unik.	123e4567-e89b-12d3-a456-42665544****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	ID grup server.	sgp-atstuj3rtoptyui****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	DuplicatedParam.TagKey	The param of %s is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
404	ResourceNotFound.Vpc	The specified resource of %s is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.