CreateServerGroup - Server Load Balancer

Membuat server group untuk instance Gateway Load Balancer (GWLB).

Deskripsi operasi

CreateServerGroup merupakan operasi asinkron. Setelah permintaan dikirim, sistem mengembalikan ID permintaan dan menjalankan tugas di latar belakang. Anda dapat memanggil operasi ListServerGroups untuk mengecek status tugas tersebut.

Jika server group berada dalam status Creating, artinya server group sedang dalam proses pembuatan.
Jika server group berada dalam status Available, artinya 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	Tipe server group. Nilai yang valid: Instance (default): memungkinkan Anda menentukan resource bertipe Ecs, Eni, atau Eci. Ip: memungkinkan Anda menambahkan server dengan menentukan alamat IP-nya.	Instance
ServerGroupName	string	No	Nama server group. Nama harus terdiri dari 2 hingga 128 karakter, dan dapat berisi angka, titik (.), garis bawah (_), serta tanda hubung (-). Nama harus dimulai dengan huruf.	testServerGroupName
Protocol	string	No	Protokol backend. Nilai yang valid: GENEVE (default) Valid values: GENEVE : GENEVE	GENEVE
Scheduler	string	No	Algoritma penjadwalan. Nilai yang valid: 5TCH (default): menentukan penghashan konsisten berdasarkan faktor-faktor berikut: alamat IP sumber, alamat IP tujuan, port sumber, protokol, dan port tujuan. Permintaan yang memiliki informasi yang sama berdasarkan faktor-faktor tersebut akan diteruskan ke server backend yang sama. 3TCH: menentukan penghashan konsisten berdasarkan faktor-faktor berikut: alamat IP sumber, alamat IP tujuan, dan protokol. Permintaan yang memiliki informasi yang sama berdasarkan faktor-faktor tersebut akan diteruskan ke server backend yang sama. 2TCH: menentukan penghashan konsisten berdasarkan faktor-faktor berikut: alamat IP sumber dan alamat IP tujuan. Permintaan yang memiliki informasi yang sama berdasarkan faktor-faktor tersebut akan diteruskan ke server backend yang sama.	5TCH
ServerFailoverMode	string	No	Menentukan cara GWLB memproses permintaan melalui koneksi yang sudah ada ketika server backend tidak berjalan sebagaimana mestinya. Nilai yang valid: NoRebalance (default): GWLB tetap meneruskan permintaan melalui koneksi yang sudah ada ke server backend yang tidak tersedia. Rebalance: GWLB meneruskan permintaan melalui koneksi yang sudah ada ke server backend yang masih sehat.	NoRebalance
VpcId	string	Yes	ID VPC. Catatan Jika ServerGroupType diatur ke Instance, hanya server dalam VPC yang ditentukan yang dapat ditambahkan ke server group.	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 false	false
ConnectionDrainTimeout	integer	No	Periode timeout pengurasan koneksi. Unit: detik Nilai yang valid: 1 hingga 3600. Nilai default: 300.	300
HealthCheckConfig	object	No	Konfigurasi pemeriksaan kesehatan.
HealthCheckConnectPort	integer	No	Port server backend yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: 1 hingga 65535. Nilai default: 80.	80
HealthCheckConnectTimeout	integer	No	Periode timeout 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. Nama domain harus terdiri dari 1 hingga 80 karakter, dan dapat berisi huruf, angka, tanda hubung (-), serta titik (.). Catatan Parameter ini hanya berlaku jika Anda mengatur HealthCheckProtocol ke HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	No	Menentukan apakah pemeriksaan kesehatan diaktifkan. Nilai yang valid: true (default) false	true
HealthCheckHttpCode	array	No	Kode status HTTP yang dikembalikan sistem untuk pemeriksaan kesehatan.
	string	No	Kode status HTTP yang dikembalikan untuk pemeriksaan kesehatan. Beberapa kode status HTTP dipisahkan dengan koma (,). Nilai yang valid: http_2xx http_3xx http_4xx http_5xx Nilai default: http_2xx. Catatan Parameter ini hanya berlaku jika Anda mengatur HealthCheckProtocol ke HTTP.	http_2xx
HealthCheckInterval	integer	No	Interval pelaksanaan 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, dan dapat berisi huruf, angka, tanda hubung (-), garis miring (/), titik (.), persen (%), tanda tanya (?), pagar (#), dan ampersand (&). URL juga dapat berisi karakter tambahan berikut: _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + = Jalur harus dimulai dengan garis miring (/). Catatan Parameter ini hanya berlaku jika Anda mengatur HealthCheckProtocol ke HTTP.	/test/index.html
HealthCheckProtocol	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: TCP (default): GWLB melakukan pemeriksaan kesehatan TCP dengan mengirim paket SYN ke server backend untuk memeriksa apakah port server backend tersedia untuk menerima permintaan. HTTP: GWLB melakukan pemeriksaan kesehatan HTTP untuk memeriksa apakah server backend sehat dengan mengirim permintaan GET yang mensimulasikan akses dari browser.	TCP
HealthyThreshold	integer	No	Jumlah kali server backend yang tidak sehat harus lulus pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan sehat. Dalam hal ini, status pemeriksaan kesehatan server backend berubah dari fail menjadi success. Nilai yang valid: 2 hingga 10. Nilai default: 2.	2
UnhealthyThreshold	integer	No	Jumlah kali server backend yang sehat harus gagal pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan tidak sehat. Dalam hal ini, status pemeriksaan kesehatan server backend berubah dari success menjadi fail. Nilai yang valid: 2 hingga 10. Nilai default: 2.	2
Tag	array<object>	No	Kunci tag. Anda dapat menentukan maksimal 20 tag dalam setiap panggilan.
	object	No	Tag.
Key	string	No	Kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag dapat mencapai 128 karakter, dan tidak boleh diawali dengan `acs:` atau `aliyun`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	testTagKey
Value	string	No	Nilai tag. Panjang nilai tag dapat mencapai 256 karakter dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
DryRun	boolean	No	Menentukan apakah hanya melakukan dry run tanpa menjalankan permintaan sebenarnya. Nilai yang valid: true: hanya melakukan dry run. Sistem memeriksa permintaan terhadap potensi masalah, termasuk nilai parameter yang hilang, sintaks permintaan yang salah, dan batas layanan. Jika permintaan gagal dalam dry run, kode kesalahan akan dikembalikan. Jika permintaan lolos dry run, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): melakukan dry run dan menjalankan permintaan sebenarnya. Jika permintaan lolos dry run, kode status HTTP 2xx dikembalikan dan operasi dilakukan.	False
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa 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 request ID sebagai client token. Request ID dapat berbeda untuk setiap permintaan.	123e4567-e89b-12d3-a456-42665544****

Elemen respons

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

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	The health check protocol is invalid. Check the input parameters.
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota gwlb_quota_servergroups_num has exceeded the quota limit.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
404	ResourceNotFound.Vpc	The specified resource of %s is not found.	The specified virtual private cloud resource does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.