UpdateServerGroupAttribute - Server Load Balancer

Memodifikasi konfigurasi grup server, seperti pemeriksaan kesehatan, persistensi sesi, nama grup server, algoritma perutean, dan protokol.

Deskripsi operasi

Description

UpdateServerGroupAttribute adalah operasi asinkron. Setelah permintaan dikirim, sistem mengembalikan ID permintaan dan menjalankan tugas di latar belakang. Anda dapat memanggil operasi ListServerGroups untuk memeriksa status grup server:

Jika grup server berada dalam status Configuring, konfigurasinya sedang dimodifikasi.
Jika grup server berada dalam status Available, konfigurasinya telah berhasil dimodifikasi.

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

alb:UpdateServerGroupAttribute

update

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ServerGroupName	string	No	Nama grup server. Nama harus terdiri dari 2 hingga 128 karakter dan dapat berisi huruf, angka, titik (.), garis bawah (_), serta tanda hubung (-). Nama harus dimulai dengan huruf.	test
Scheduler	string	No	Algoritma penjadwalan. Nilai yang valid: Wrr: algoritma round-robin berbobot. Server backend dengan bobot lebih tinggi menerima lebih banyak permintaan dibandingkan server dengan bobot lebih rendah. Wlc: algoritma jumlah koneksi paling sedikit dengan bobot. Permintaan didistribusikan berdasarkan bobot dan jumlah koneksi ke server backend. Jika dua server backend memiliki bobot yang sama, server backend dengan jumlah koneksi lebih sedikit akan menerima lebih banyak permintaan. Sch: algoritma penghashan konsisten. Permintaan dari IP sumber yang sama didistribusikan ke server backend yang sama.	Wrr
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menghasilkan token ini di sisi client, tetapi harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan ID permintaan sebagai token client. ID permintaan dapat berbeda untuk setiap permintaan.	5A2CFF0E-5718-45B5-9D4D-70B3******
DryRun	boolean	No	Menentukan apakah hanya melakukan dry run tanpa menjalankan permintaan sebenarnya. Nilai yang valid: true: memeriksa permintaan tanpa menjalankan operasi. Sistem memeriksa potensi masalah pada permintaan, termasuk nilai parameter yang hilang, sintaksis 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` akan dikembalikan dan operasi dijalankan.	true
HealthCheckConfig	object	No	Konfigurasi pemeriksaan kesehatan.
HealthCheckConnectPort	integer	No	Port backend yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: 0 hingga 65535. Jika Anda menetapkan nilai ke 0, port backend digunakan untuk pemeriksaan kesehatan. Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true.	80
HealthCheckEnabled	boolean	No	Menentukan apakah fitur pemeriksaan kesehatan diaktifkan. Nilai yang valid: true false	true
HealthCheckHost	string	No	Nama domain yang digunakan untuk pemeriksaan kesehatan. Backend Server Internal IP (default): Gunakan alamat IP internal server backend sebagai nama domain pemeriksaan kesehatan. Custom Domain Name: Masukkan nama domain. Nama domain harus terdiri dari 1 hingga 80 karakter. Nama domain dapat berisi huruf kecil, angka, tanda hubung (-), dan titik (.). Nama domain harus mengandung setidaknya satu titik (.) tetapi tidak boleh dimulai atau diakhiri dengan titik (.). Label domain paling kanan hanya boleh berisi huruf, dan tidak boleh berisi angka atau tanda hubung (-). Nama domain tidak boleh dimulai atau diakhiri dengan tanda hubung (-). Catatan Parameter ini hanya berlaku jika HealthCheckProtocol ditetapkan ke HTTP, HTTPS, atau gRPC.	example.com
HealthCheckCodes	array	No	Kode status HTTP yang menunjukkan server backend dalam kondisi sehat.
	string	No	Kode status HTTP yang menunjukkan server backend dalam kondisi sehat. Ketika HealthCheckProtocol ditetapkan ke HTTP atau HTTPS, Anda dapat menetapkan HealthCheckCodes ke http_2xx (nilai default), http_3xx, http_4xx, dan http_5xx. Pisahkan beberapa kode status HTTP dengan koma (,). Ketika HealthCheckProtocol ditetapkan ke gRPC, nilai yang valid untuk HealthCheckCodes berkisar dari 0 hingga 99. Nilai default adalah 0. Rentang nilai didukung. Anda dapat menentukan maksimal 20 rentang nilai. Pisahkan beberapa rentang nilai dengan koma (,). Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true dan HealthCheckProtocol ke HTTP, HTTPS, atau gRPC.	200
HealthCheckHttpVersion	string	No	Versi HTTP yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: HTTP1.0 HTTP1.1 Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true dan HealthCheckProtocol ke HTTP atau HTTPS.	HTTP1.1
HealthCheckInterval	integer	No	Interval pelaksanaan pemeriksaan kesehatan. Satuan: detik. Nilai yang valid: 1 hingga 50. Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true.	5
HealthCheckMethod	string	No	Metode HTTP yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: GET: Jika panjang respons melebihi 8 KB, respons akan dipotong. Namun, hasil pemeriksaan kesehatan tidak terpengaruh. POST: Pemeriksaan kesehatan gRPC menggunakan metode POST secara default. HEAD: Pemeriksaan kesehatan HTTP dan HTTPS menggunakan metode HEAD secara default. Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true dan HealthCheckProtocol ke HTTP, HTTPS, atau gRPC.	HEAD
HealthCheckPath	string	No	URL yang digunakan untuk pemeriksaan kesehatan. URL harus terdiri dari 1 hingga 80 karakter, dan dapat berisi huruf, angka, serta karakter khusus berikut: `- / . % ? # & =`. URL juga dapat berisi karakter tambahan berikut: `_ ; ~ ! ( ) * [ ] @ $ ^ : ' , +`. URL harus dimulai dengan garis miring (`/`). Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true dan HealthCheckProtocol ke HTTP atau HTTPS.	/test/index.html
HealthCheckProtocol	string	No	Protokol yang ingin Anda gunakan untuk pemeriksaan kesehatan. Nilai yang valid: HTTP: Pemeriksaan kesehatan HTTP mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk memeriksa ketersediaan server backend. HTTPS: Pemeriksaan kesehatan HTTPS mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk memeriksa ketersediaan server backend. HTTPS mendukung enkripsi dan memberikan keamanan lebih tinggi dibandingkan HTTP. TCP: Pemeriksaan kesehatan TCP mengirim paket TCP SYN ke server backend untuk memeriksa ketersediaan server backend. gRPC: Pemeriksaan kesehatan gRPC mengirim permintaan POST atau GET ke server backend untuk memeriksa apakah server backend dalam kondisi sehat.	HTTP
HealthCheckTimeout	integer	No	Periode timeout respons pemeriksaan kesehatan. Jika instans ECS backend tidak merespons dalam periode timeout yang ditentukan, instans ECS tersebut gagal dalam pemeriksaan kesehatan. Satuan: detik. Nilai yang valid: 1 hingga 300. Catatan Parameter ini hanya berlaku jika Anda menetapkan HealthCheckEnabled ke true.	3
HealthyThreshold	integer	No	Jumlah kali server backend yang tidak sehat harus lulus pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan sehat. Dalam kasus ini, status pemeriksaan kesehatan server backend berubah dari fail menjadi success. Nilai yang valid: 2 hingga 10.	4
UnhealthyThreshold	integer	No	Jumlah kali server backend yang sehat harus gagal pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan tidak sehat. Dalam kasus ini, status pemeriksaan kesehatan server backend berubah dari success menjadi fail. Nilai yang valid: 2 hingga 10.	4
StickySessionConfig	object	No	Konfigurasi persistensi sesi.
Cookie	string	No	Cookie yang akan dikonfigurasi di server. Cookie harus terdiri dari 1 hingga 200 karakter dan hanya boleh berisi karakter ASCII dan angka. Cookie tidak boleh berisi koma (,), titik koma (;), atau spasi. Cookie tidak boleh dimulai dengan tanda dolar ($). Catatan Parameter ini berlaku ketika parameter StickySessionEnabled ditetapkan ke true dan parameter StickySessionType ditetapkan ke Server.	B490B5EBF6F3CD402E515D22B******
CookieTimeout	integer	No	Periode timeout cookie. Satuan: detik. Nilai yang valid: 1 hingga 86400. Catatan Parameter ini berlaku ketika parameter StickySessionEnabled ditetapkan ke true dan parameter StickySessionType ditetapkan ke Insert.	1000
StickySessionEnabled	boolean	No	Menentukan apakah persistensi sesi diaktifkan. Nilai yang valid: true false (default)	false
StickySessionType	string	No	Metode yang digunakan untuk menangani cookie. Nilai yang valid: Insert: menyisipkan cookie. ALB menyisipkan cookie (SERVERID) ke dalam paket respons HTTP atau HTTPS pertama yang dikirim ke client. Permintaan berikutnya dari client berisi cookie ini dan pendengar meneruskan permintaan tersebut ke server backend yang telah dicatat. Server: menulis ulang cookie. Ketika ALB mendeteksi cookie yang ditentukan pengguna, ALB menimpa cookie asli dengan cookie yang ditentukan pengguna. Permintaan selanjutnya ke ALB membawa cookie yang ditentukan pengguna ini, dan ALB menentukan server tujuan permintaan berdasarkan cookie tersebut. Catatan Parameter ini berlaku ketika parameter StickySessionEnabled ditetapkan ke true untuk grup server.	Insert
ServerGroupId	string	Yes	ID grup server.	sgp-atstuj3rtop****
UpstreamKeepaliveEnabled	boolean	No	Menentukan apakah koneksi TCP persisten diaktifkan.	true
ServiceName	string	No	Parameter ini hanya tersedia jika pengontrol Ingress ALB digunakan. Dalam hal ini, tetapkan parameter ini ke nama `Kubernetes Service` yang terkait dengan grup server.	test2
UchConfig	object	No	Konfigurasi penghashan konsisten berdasarkan URL.
Type	string	Yes	Jenis parameter. Hanya string kueri yang didukung.	QueryString
Value	string	Yes	Nilai parameter yang digunakan untuk penghashan konsisten.	abc
ConnectionDrainConfig	object	No	Konfigurasi pengurasan koneksi. Setelah pengurasan koneksi diaktifkan, SLB tetap mentransmisikan data untuk periode waktu tertentu setelah server backend dihapus atau dinyatakan tidak sehat. Catatan Instans SLB dasar tidak mendukung pengurasan koneksi. Instans SLB Standar dan SLB dengan WAF mendukung pengurasan koneksi. Grup server tipe server dan IP mendukung pengurasan koneksi. Grup server tipe Function Compute tidak mendukung pengurasan koneksi.
ConnectionDrainEnabled	boolean	No	Menentukan apakah pengurasan koneksi diaktifkan. Nilai yang valid: true false	false
ConnectionDrainTimeout	integer	No	Periode timeout pengurasan koneksi. Nilai yang valid: 0 hingga 900.	300
SlowStartConfig	object	No	Konfigurasi mulai lambat. Setelah mulai lambat diaktifkan, ALB melakukan pra-ambil data ke server backend yang baru ditambahkan. Permintaan yang didistribusikan ke server backend meningkat secara bertahap. Catatan Instans ALB dasar tidak mendukung mulai lambat. Instans ALB Standar dan ALB dengan WAF mendukung mulai lambat. Grup server tipe instans dan IP mendukung mulai lambat. Grup server tipe Function Compute tidak mendukung mulai lambat. Mulai lambat hanya didukung oleh algoritma penjadwalan round-robin berbobot.
SlowStartEnabled	boolean	No	Menunjukkan apakah mulai lambat diaktifkan. Nilai yang valid: true false	false
SlowStartDuration	integer	No	Durasi mulai lambat.	30
CrossZoneEnabled	boolean	No	Menunjukkan apakah load balancing lintas zona diaktifkan untuk grup server. Nilai yang valid: true (default) false Catatan Instans ALB dasar tidak mendukung grup server yang menonaktifkan load balancing lintas zona. Hanya instans ALB Standar dan ALB dengan WAF yang mendukung grup server dengan load balancing lintas zona. Load balancing lintas zona dapat dinonaktifkan untuk grup server tipe server dan IP, tetapi tidak untuk grup server tipe Function Compute. Ketika load balancing lintas zona dinonaktifkan, persistensi sesi tidak dapat diaktifkan.	true

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
JobId	string	ID pekerjaan asinkron.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	ID permintaan.	365F4154-92F6-4AE4-92F8-7FF3*****

Contoh

Respons sukses

JSONformat

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3*****"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.
400	OperationDenied.UpstreamKeepaliveDisabled	The operation is not allowed because of UpstreamKeepaliveDisabled.
400	OperationDenied.UpstreamKeepaliveEnabled	The operation is not allowed because of UpstreamKeepaliveEnabled.
400	CloseUpstreamKeepaliveNotSupport	The param of UpstreamKeepalive is not Support.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.