Gunakan CreateServerGroup untuk membuat server group - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Membuat kelompok server di wilayah tertentu.

Deskripsi operasi

CreateServerGroup adalah operasi asinkron. Setelah Anda mengirim permintaan, sistem akan mengembalikan ID permintaan. Namun, kelompok server dari instans Network Load Balancer (NLB) belum dibuat. Sistem terus membuat kelompok server di latar belakang. Anda dapat memanggil GetJobStatus untuk mengkueri status pembuatan kelompok server:

Jika status node adalah Succeeded, kelompok server telah dibuat.
Jika status node adalah Processing, kelompok server sedang dibuat. Dalam keadaan ini, Anda hanya dapat menjalankan operasi kueri dan tidak dapat menjalankan operasi lain.

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

nlb:CreateServerGroup

create

*ServerGroup

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

*VPC

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ServerGroupType	string	No	Tipe kelompok server. Nilai valid: Instance (default): tipe instans. Tipe kelompok server ini mendukung penambahan instans bertipe Ecs, Eni, dan Eci. Ip: tipe alamat IP. Tipe kelompok server ini mendukung penambahan server backend langsung melalui alamat IP.	Instance
ServerGroupName	string	Yes	Nama kelompok server. Panjang nama harus 2 hingga 128 karakter, dan harus dimulai dengan huruf besar, huruf kecil, atau karakter Tionghoa. Nama dapat berisi angka, titik (.), garis bawah (_), dan tanda hubung (-).	NLB_ServerGroup
AddressIPVersion	string	No	Versi protokol. Nilai valid: ipv4 (default): IPv4. DualStack: dual-stack.	ipv4
IpVersionAffinityMode	string	No	Kebijakan penjadwalan trafik dalam mode dual-stack: NonAffinity (default): mode non-affinity. Trafik diteruskan ke server backend yang sehat berdasarkan algoritma penjadwalan, terlepas dari versi protokol IP sumber. Affinity: mode affinity. Trafik diteruskan berdasarkan versi protokol IP dari sumber permintaan. Permintaan IPv4 hanya diteruskan ke server backend IPv4, dan permintaan IPv6 hanya diteruskan ke server backend IPv6. Catatan Parameter ini hanya berlaku jika AddressIPVersion diatur ke DualStack.	Affinity
Protocol	string	No	Protokol komunikasi yang digunakan untuk meneruskan permintaan ke server backend. Nilai valid: TCP (default) UDP TCP_UDP Catatan Jika parameter ini diatur ke UDP, kelompok server hanya dapat dikaitkan dengan pendengar UDP. Jika parameter ini diatur ke TCP dan PreserveClientIpEnabled diatur ke true, kelompok server hanya dapat dikaitkan dengan pendengar TCP. Jika parameter ini diatur ke TCP dan PreserveClientIpEnabled diatur ke false, kelompok server dapat dikaitkan dengan pendengar TCPSSL dan TCP. Jika parameter ini diatur ke TCP_UDP, kelompok server dapat dikaitkan dengan pendengar TCP dan UDP.	TCP
VpcId	string	Yes	ID virtual private cloud (VPC) tempat kelompok server berada. Catatan Jika ServerGroupType diatur ke Instance, hanya server di VPC ini yang dapat ditambahkan ke kelompok server.	vpc-bp15zckdt37pq72zv****
AnyPortEnabled	boolean	No	Apakah akan mengaktifkan penerusan semua Port. Nilai valid: true: diaktifkan. false (default): dinonaktifkan.	false
ConnectionDrainEnabled	boolean	No	Apakah akan mengaktifkan pengurasan koneksi. Nilai valid: true: diaktifkan. false (default): dinonaktifkan.	false
ConnectionDrainTimeout	integer	No	Periode waktu tunggu pengurasan koneksi. Unit: detik. Nilai valid: 0 hingga 900.	10
Scheduler	string	No	Algoritma penjadwalan. Nilai valid: Wrr (default): weighted round-robin. Server backend dengan bobot lebih tinggi dipolling lebih sering. Wlc: weighted least connections. Selain bobot setiap server backend, beban aktual (jumlah koneksi) juga dipertimbangkan. Ketika bobot sama, server backend dengan koneksi saat ini lebih sedikit dipolling lebih sering. rr: round-robin. Permintaan didistribusikan ke server backend secara berurutan. sch: penghashan IP sumber. Permintaan dari alamat IP sumber yang sama didistribusikan ke server backend yang sama. tch: penghashan empat elemen. Penghashan konsisten berdasarkan empat elemen (alamat IP sumber, alamat IP tujuan, port sumber, dan port tujuan). Aliran yang sama didistribusikan ke server backend yang sama. qch: penghashan ID QUIC. Permintaan dengan ID QUIC yang sama didistribusikan ke server backend yang sama. Catatan Penghashan ID QUIC hanya didukung ketika protokol backend adalah UDP.	Wrr
PreserveClientIpEnabled	boolean	No	Apakah akan mengaktifkan pelestarian IP klien. Nilai valid: true (default): diaktifkan. false: dinonaktifkan. Catatan Jika Protocol diatur ke TCP dan parameter ini diatur ke true, kelompok server tidak dapat dikaitkan dengan pendengar TCPSSL.	true
HealthCheckConfig	object	No	Konfigurasi pemeriksaan kesehatan.
HealthCheckEnabled	boolean	No	Apakah akan mengaktifkan pemeriksaan kesehatan. Nilai valid: true (default): diaktifkan. false: dinonaktifkan.	true
HealthCheckType	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai valid: TCP HTTP UDP	TCP
HealthCheckConnectPort	integer	No	Port server backend yang digunakan untuk pemeriksaan kesehatan. Nilai valid: 0 hingga 65535. Nilai default: 0, yang menunjukkan bahwa port server backend digunakan untuk pemeriksaan kesehatan.	0
HealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan berhasil berturut-turut yang harus terjadi sebelum server backend dinyatakan sehat (status berubah dari fail menjadi success). Nilai valid: 2 hingga 10. Nilai default: 2.	2
UnhealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan gagal berturut-turut yang harus terjadi sebelum server backend dinyatakan tidak sehat (status berubah dari success menjadi fail). Nilai valid: 2 hingga 10. Nilai default: 2.	2
HealthCheckConnectTimeout	integer	No	Periode waktu tunggu maksimum untuk tanggapan pemeriksaan kesehatan. Unit: detik. Nilai valid: 1 hingga 300. Nilai default: 5.	5
HealthCheckInterval	integer	No	Interval antara dua pemeriksaan kesehatan berturut-turut. Unit: detik. Nilai default: 5. Jika HealthCheckType diatur ke TCP atau HTTP, nilai valid adalah 1 hingga 50. Jika HealthCheckType diatur ke UDP, nilai valid adalah 1 hingga 300. Atur interval ke nilai yang lebih besar atau sama dengan periode waktu tunggu tanggapan untuk mencegah tanggapan probe UDP salah diidentifikasi sebagai tidak ada tanggapan karena waktu tunggu habis.	5
HealthCheckDomain	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan. Nilai valid: $SERVER_IP: alamat IP privat server backend. domain: nama domain spesifik. Panjang nama domain harus 1 hingga 80 karakter dan hanya dapat berisi huruf, angka, tanda hubung (-), dan titik (.). Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	$SERVER_IP
HealthCheckUrl	string	No	Jalur Pemeriksaan Kesehatan. Panjang jalur harus 1 hingga 80 karakter dan hanya dapat berisi huruf, angka, serta karakter berikut: `-/.%?#&`. Jalur harus dimulai dengan garis miring (/). Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	/test/index.html
HealthCheckHttpCode	array	No	Kode status HTTP yang dikembalikan untuk server backend yang sehat. Pisahkan beberapa kode status dengan koma (,). Nilai valid: http_2xx (default), http_3xx, http_4xx, dan http_5xx. Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.
	string	No	Kode status HTTP yang dikembalikan untuk server backend yang sehat. Pisahkan beberapa kode status dengan koma (,). Nilai valid: http_2xx (default), http_3xx, http_4xx, dan http_5xx. Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	http_2xx
HttpCheckMethod	string	No	Metode pemeriksaan kesehatan. Nilai valid: GET (default) dan HEAD. Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	GET
HealthCheckReq	string	No	String kueri dalam permintaan untuk pemeriksaan kesehatan pendengar UDP. String hanya dapat berisi huruf dan angka, dengan panjang maksimum 512 karakter.	hello
HealthCheckExp	string	No	String kueri dalam permintaan untuk pemeriksaan kesehatan pendengar UDP. String hanya dapat berisi huruf dan angka, dengan panjang maksimum 512 karakter.	ok
HealthCheckHttpVersion	string	No	Versi HTTP untuk pemeriksaan kesehatan. Nilai valid: HTTP1.0 (default) dan HTTP1.1. Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	HTTP1.0
ResourceGroupId	string	No	ID kelompok sumber daya tempat grup server berada.	rg-atstuj3rtop****
DryRun	boolean	No	Apakah akan melakukan dry run. Nilai valid: true: melakukan dry run tanpa membuat kelompok server. Sistem memeriksa parameter wajib, format permintaan, dan batas layanan. Jika pemeriksaan gagal, kesalahan yang sesuai akan dikembalikan. Jika pemeriksaan berhasil, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): mengirim permintaan. Setelah permintaan lulus pemeriksaan, kode status HTTP 2xx akan dikembalikan dan operasi akan dilakukan.	true
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token unik di antara berbagai permintaan. Token klien hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem akan menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	No	ID wilayah instans Network Load Balancer (NLB). Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
Tag	array<object>	No	Daftar tag.
	object	No	Tag.
Key	string	No	Kunci tag. Panjang kunci tag dapat mencapai 64 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Kunci tidak boleh berisi `http://` atau `https://`. Karakter valid meliputi huruf, angka, garis bawah (_), titik (.), titik dua (:), garis miring (/), tanda sama dengan (=), tanda plus (+), tanda hubung (-), dan tanda at (@). Anda dapat menambahkan hingga 20 tag dalam setiap panggilan.	env
Value	string	No	Nilai tag. Panjang nilai tag dapat mencapai 128 karakter dan tidak boleh dimulai dengan `aliyun` atau `acs:`. Nilai tidak boleh berisi `http://` atau `https://`. Karakter valid meliputi huruf, angka, garis bawah (_), titik (.), titik dua (:), garis miring (/), tanda sama dengan (=), tanda plus (+), tanda hubung (-), dan tanda at (@). Anda dapat menambahkan hingga 20 tag dalam setiap panggilan.	product

Elemen respons

Element	Type	Description	Example
	object	Tanggapan untuk membuat kelompok server.
RequestId	string	ID permintaan.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	ID kelompok server.	sgp-atstuj3rtoptyui****
JobId	string	ID tugas asinkron.	72dcd26b-f12d-4c27-b3af-18f6aed5****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig	The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.
400	IllegalParamFormat.ParseCreateRsPoolRequestFailed	The param format of CreateRsPoolRequest is illegal.
400	IllegalParam.PreserveClientIpSwitch	The param of PreserveClientIpSwitch is illegal.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.
400	OperationDenied.UidNotAllowQuic29	The operation is not allowed because of uid not allow quic29 version.
400	IlleagalParam.healthCheckUrl	The parameter of healthCheckUrl in healthCheckConfig is illegal.
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	MissingParam.%s	The parameter of %s is missing.
400	IllegalParam.ConnectionDrainTimeout	The param of ConnectionDrainTimeout is illegal.
400	IllegalParam	The param of %s is illegal.
400	SystemBusy	System is busy, please try again later.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.
404	ResourceNotFound.ResourceGroup	The param of resourceGroup not existed.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.