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

Membuat kelompok server di wilayah tertentu.

Deskripsi operasi

Operasi CreateServerGroup bersifat asinkron. Sistem mengembalikan ID permintaan, tetapi kelompok server Network Load Balancer (NLB) belum dibuat, dan tugas pembuatan masih berjalan di latar belakang. Anda dapat memanggil operasi GetJobStatus untuk mengkueri status pembuatan kelompok server:

Jika status tugas adalah Succeeded, kelompok server telah dibuat.
Jika status tugas adalah Processing, kelompok server sedang dibuat. Dalam status ini, Anda hanya dapat melakukan operasi kueri dan tidak dapat melakukan 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 server. Tipe kelompok server ini mendukung penambahan instans Ecs, Eni, dan Eci. Ip: tipe alamat IP. Tipe kelompok server ini mendukung penambahan server backend secara langsung menggunakan alamat IP.	Instance
ServerGroupName	string	Yes	Nama kelompok server. Panjang nama harus 2 hingga 128 karakter, dan harus diawali dengan huruf 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. Nilai valid: NonAffinity (default): mode non-affinity. Trafik diteruskan ke server backend yang sehat berdasarkan algoritma penjadwalan tanpa memperhatikan versi protokol IP sumber. Affinity: mode affinity. Trafik diteruskan berdasarkan versi protokol IP 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 trafik 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 VPC tempat kelompok server diterapkan. 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 Penerusan port. Nilai valid: true: Mengaktifkan penerusan Penerusan port. false (default): Menonaktifkan penerusan Penerusan port.	false
ConnectionDrainEnabled	boolean	No	Apakah akan mengaktifkan pengurasan koneksi. Nilai valid: true: Mengaktifkan pengurasan koneksi. false (default): Menonaktifkan pengurasan koneksi.	false
ConnectionDrainTimeout	integer	No	Periode waktu tunggu untuk 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 memiliki peluang lebih besar untuk dipilih. Wlc: weighted least connections. Selain bobot setiap server backend, beban aktual (jumlah koneksi) server backend juga dipertimbangkan. Jika bobot sama, server backend dengan koneksi aktif lebih sedikit memiliki peluang lebih besar untuk dipilih. rr: round-robin. Permintaan eksternal didistribusikan ke server backend secara berurutan. sch: penghashan IP sumber. Permintaan dari alamat IP sumber yang sama dijadwalkan ke server backend yang sama. tch: penghashan 4-tupel. Penghashan konsisten berdasarkan 4-tupel (alamat IP sumber, alamat IP tujuan, port sumber, dan port tujuan). Permintaan dari aliran yang sama dijadwalkan ke server backend yang sama. qch: penghashan ID QUIC. Permintaan dengan ID QUIC yang sama dijadwalkan ke server backend yang sama. Catatan Penghashan ID QUIC hanya didukung ketika protokol backend adalah UDP.	Wrr
PreserveClientIpEnabled	boolean	No	Apakah akan mengaktifkan pelestarian alamat IP klien. Nilai valid: true (default): Mengaktifkan pelestarian alamat IP klien. false: Menonaktifkan pelestarian alamat IP klien. 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.
HealthCheckConnectPort	integer	No	Port server backend yang digunakan untuk pemeriksaan kesehatan. Nilai valid: 0 hingga 65535. Nilai default: 0. Nilai ini menunjukkan bahwa port server backend digunakan untuk pemeriksaan kesehatan.	0
HealthCheckConnectTimeout	integer	No	Periode waktu tunggu maksimum untuk tanggapan pemeriksaan kesehatan. Unit: detik. Nilai valid: 1 hingga 300. Nilai default: 5.	5
HealthCheckDomain	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan. Nilai valid: $SERVER_IP: alamat IP internal server backend. domain: nama domain tertentu. 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
HealthCheckEnabled	boolean	No	Apakah akan mengaktifkan pemeriksaan kesehatan. Nilai valid: true (default): Mengaktifkan pemeriksaan kesehatan. false: Menonaktifkan pemeriksaan kesehatan.	true
HealthCheckExp	string	No	String kueri dalam permintaan untuk pemeriksaan kesehatan pendengar UDP. String hanya dapat berisi huruf dan angka, dengan panjang maksimal 512 karakter.	ok
HealthCheckHttpCode	array	No	Kode status HTTP untuk tanggapan 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 untuk tanggapan 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
HealthCheckHttpVersion	string	No	Versi protokol HTTP untuk pemeriksaan kesehatan. Nilai valid: HTTP1.0 (default) dan HTTP1.1. Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	HTTP1.0
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. Anda harus mengatur interval agar lebih besar atau sama dengan periode waktu tunggu tanggapan untuk memastikan tanggapan probe UDP tidak salah dinilai sebagai tidak responsif karena waktu tunggu.	5
HealthCheckReq	string	No	String kueri dalam permintaan untuk pemeriksaan kesehatan pendengar UDP. String hanya dapat berisi huruf dan angka, dengan panjang maksimal 512 karakter.	hello
HealthCheckType	string	No	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai valid: TCP HTTP UDP	TCP
HealthCheckUrl	string	No	Jalur pemeriksaan kesehatan. Panjang jalur harus 1 hingga 80 karakter, dan hanya dapat berisi huruf, angka, serta karakter khusus berikut: `-/.%?#&`. Jalur harus diawali dengan garis miring (/). Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	/test/index.html
HealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan berhasil berturut-turut yang harus terjadi sebelum status pemeriksaan kesehatan server backend berubah dari fail menjadi success. Nilai valid: 2 hingga 10. Nilai default: 2.	2
HttpCheckMethod	string	No	Metode HTTP yang digunakan untuk pemeriksaan kesehatan. Nilai valid: GET (default) dan HEAD. Catatan Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.	GET
UnhealthyThreshold	integer	No	Jumlah pemeriksaan kesehatan gagal berturut-turut yang harus terjadi sebelum status pemeriksaan kesehatan server backend berubah dari success menjadi fail. Nilai valid: 2 hingga 10. Nilai default: 2.	2
ResourceGroupId	string	No	ID kelompok sumber daya tempat grup server berada.	rg-atstuj3rtop****
DryRun	boolean	No	Apakah akan melakukan pemeriksaan awal pada permintaan saja. Nilai valid: true: melakukan pemeriksaan awal pada permintaan tanpa membuat kelompok server. Sistem memeriksa apakah parameter wajib telah ditentukan, format permintaan, dan batas layanan. Jika permintaan gagal dalam pemeriksaan awal, kode kesalahan yang sesuai akan dikembalikan. Jika permintaan lulus pemeriksaan awal, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): mengirimkan permintaan. Jika permintaan lulus pemeriksaan awal, kode status HTTP 2xx akan dikembalikan dan operasi akan dijalankan.	true
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi Anda harus memastikan nilainya unik di antara permintaan yang berbeda. Token klien hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId dari permintaan API sebagai ClientToken. RequestId dari setiap permintaan API bersifat unik.	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 maksimal 64 karakter, dan tidak dapat diawali dengan `aliyun` atau `acs:`. Kunci tag tidak dapat berisi `http://` atau `https://`. Kunci tag dapat berisi huruf, angka, garis bawah (_), titik (.), titik dua (:), garis miring (/), tanda sama dengan (=), tanda tambah (+), tanda hubung (-), dan tanda at (@). Anda dapat menambahkan hingga 20 tag dalam satu panggilan.	env
Value	string	No	Nilai tag. Panjang nilai tag maksimal 128 karakter, dan tidak dapat diawali dengan `aliyun` atau `acs:`. Nilai tag tidak dapat berisi `http://` atau `https://`. Nilai tag dapat berisi huruf, angka, garis bawah (_), titik (.), titik dua (:), garis miring (/), tanda sama dengan (=), tanda tambah (+), tanda hubung (-), dan tanda at (@). Anda dapat menambahkan hingga 20 tag dalam satu panggilan.	product

Elemen respons

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

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IllegalParam.AnyPortServerGroupConflictWithHealthCheckConfig	The param of AnyPortServerGroupConflictWithHealthCheckConfig is illegal.	Konfigurasi kelompok server mengalami konflik dengan pengaturan Pemeriksaan kesehatan. Periksa parameter konfigurasi.
400	IllegalParamFormat.ParseCreateRsPoolRequestFailed	The param format of CreateRsPoolRequest is illegal.	Format parameter CreateRsPoolRequestFailed tidak valid. Lihat Referensi API untuk memeriksa parameter permintaan.
400	IllegalParam.PreserveClientIpSwitch	The param of PreserveClientIpSwitch is illegal.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	VPC yang ditentukan tidak mendukung IPv6.
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.	healthCheckDomain dalam konfigurasi Pemeriksaan kesehatan tidak valid. Periksa parameter input.
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.	URL Pemeriksaan kesehatan yang digunakan dalam pengaturan Pemeriksaan kesehatan tidak valid.
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.	Parameter ServerGroupName tidak valid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Permintaan DryRun telah lulus validasi.
400	MissingParam.%s	The parameter of %s is missing.	Parameter %s hilang. Periksa parameter input.
400	IllegalParam.ConnectionDrainTimeout	The param of ConnectionDrainTimeout is illegal.	Parameter ConnectionDrainTimeout tidak valid. Periksa parameter input.
400	IllegalParam	The param of %s is illegal.	Parameter input mengandung nilai yang tidak valid. Periksa input.
400	SystemBusy	System is busy, please try again later.	Sistem sedang sibuk. Coba lagi nanti.
400	QuotaExceeded.QuotaInsufficient	The quota of %s is exceeded, usage %s/%s.	Kuota tidak mencukupi. Digunakan: %s/%s. Ubah kuota di Pusat Kuota.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Otentikasi gagal karena akun tidak memiliki izin yang diperlukan.
404	ResourceNotFound.Vpc	The specified resource of Vpc is not found.	Sumber daya VPC yang ditentukan tidak ditemukan. Periksa parameter input.
404	ResourceNotFound.ResourceGroup	The param of resourceGroup not existed.	Kelompok sumber daya tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.