Gunakan UpdateServerGroupAttribute untuk memodifikasi konfigurasi grup server - Server Load Balancer - Alibaba Cloud - Server Load Balancer

Memperbarui pengaturan grup server, seperti health check, persistensi sesi, nama, algoritma penjadwalan, dan protokol.

Deskripsi operasi

API UpdateServerGroupAttribute bersifat asinkron. Setelah Anda memanggil API ini, sistem mengembalikan ID permintaan dan menjalankan pembaruan di latar belakang. Perubahan konfigurasi tidak langsung terjadi. Anda dapat memanggil API ListServerGroups untuk menanyakan status grup server:

Status Configuring menunjukkan bahwa grup server sedang diperbarui.
Status Available menunjukkan bahwa pembaruan selesai.

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, dimulai dengan huruf, angka, atau karakter Tionghoa, dan dapat berisi huruf, angka, titik (.), garis bawah (_), tanda hubung (-), dan spasi.	test
Scheduler	string	No	Algoritma penjadwalan. Nilai yang valid: Wrr: weighted round robin. Server backend dengan bobot lebih tinggi menerima lebih banyak permintaan. Wlc: weighted least connections. Algoritma ini merutekan permintaan berdasarkan bobot dan beban saat ini (jumlah koneksi) dari setiap server backend. Jika server backend memiliki bobot yang sama, server dengan koneksi aktif lebih sedikit menerima lebih banyak permintaan. Sch: consistent hashing. Alamat IP sumber digunakan sebagai kunci hash secara default. Jika Anda mengonfigurasi parameter `UchConfig`, parameter URL akan digunakan sebagai kunci hash.	Wrr
ClientToken	string	No	Client token, yang digunakan untuk memastikan idempotensi permintaan. Hasilkan nilai unik pada klien Anda dan pastikan nilainya unik untuk setiap permintaan. Client token hanya boleh berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem menggunakan RequestId dari permintaan API sebagai client token.	5A2CFF0E-5718-45B5-9D4D-70B3******
DryRun	boolean	No	Menentukan apakah akan melakukan dry run. Nilai yang valid: true: Melakukan dry run untuk memeriksa validitas permintaan tanpa memodifikasi sumber daya. Sistem memeriksa parameter wajib, format permintaan, dan batas layanan. Jika pemeriksaan berhasil, kode kesalahan `DryRunOperation` akan dikembalikan. false (default): Mengirim permintaan normal. Jika permintaan valid, operasi dilakukan dan kode status HTTP `2xx` dikembalikan.	true
HealthCheckConfig	object	No	Pengaturan health check.	true
HealthCheckConnectPort	integer	No	Port pada server backend yang digunakan untuk health check. Nilai yang valid: 0 hingga 65535. Jika Anda menetapkan nilai ini ke 0, port server backend akan digunakan untuk health check. Catatan Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true.	80
HealthCheckEnabled	boolean	No	Menentukan apakah akan mengaktifkan health check. Nilai yang valid: true: Mengaktifkan health check. false: Menonaktifkan health check.	true
HealthCheckHost	string	No	Nama domain yang digunakan untuk health check. Gunakan alamat IP privat dari server backend (default): Alamat IP privat server backend digunakan untuk health check. Tentukan nama domain: Masukkan nama domain yang memenuhi persyaratan berikut: Nama domain harus terdiri dari 1 hingga 80 karakter. Dapat berisi huruf kecil, angka, tanda hubung (-), dan titik (.). Harus mengandung setidaknya satu titik (.), yang tidak boleh menjadi karakter pertama atau terakhir. Label domain paling kanan hanya boleh berisi huruf dan tidak boleh berisi angka atau tanda hubung (-). Tanda hubung (-) tidak boleh menjadi karakter pertama atau terakhir. Catatan Parameter ini hanya berlaku ketika HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.	example.com
HealthCheckCodes	array	No	Kode status HTTP yang menunjukkan health check berhasil.
	string	No	Kode status yang menunjukkan health check berhasil. Ketika HealthCheckProtocol diatur ke HTTP atau HTTPS, Anda dapat menentukan http_2xx (default), http_3xx, http_4xx, dan http_5xx. Pisahkan beberapa nilai dengan tanda koma (,). Ketika HealthCheckProtocol diatur ke gRPC, kode status yang valid adalah dari 0 hingga 99. Nilai default adalah 0. Anda dapat menentukan hingga 20 rentang. Pisahkan beberapa rentang dengan tanda koma (,). Catatan Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true dan HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.	200
HealthCheckHttpVersion	string	No	Versi HTTP untuk health check. Nilai yang valid: HTTP1.0 HTTP1.1 Catatan Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true dan HealthCheckProtocol diatur ke HTTP atau HTTPS.	HTTP1.1
HealthCheckInterval	integer	No	Interval, dalam detik, antara health check. Nilai yang valid: 1 hingga 50. Catatan Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true.	5
HealthCheckMethod	string	No	Metode yang digunakan untuk health check. Nilai yang valid: GET: Jika body respons lebih besar dari 8 KB, body akan dipotong. Hal ini tidak memengaruhi hasil health check. POST: Secara default, listener gRPC menggunakan POST untuk health check. HEAD: Secara default, listener HTTP dan HTTPS menggunakan HEAD untuk health check. Catatan Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true dan HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.	HEAD
HealthCheckPath	string	No	Path tempat permintaan health check dikirim. Path harus terdiri dari 1 hingga 80 karakter. Dapat berisi huruf, angka, dan karakter berikut: `-/.%?#&=` dan `_~;!()[]@$^:',+`. Path harus dimulai dengan `/`. Catatan* Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true dan HealthCheckProtocol diatur ke HTTP atau HTTPS.	/test/index.html
HealthCheckProtocol	string	No	Protokol yang digunakan untuk health check. Nilai yang valid: HTTP: Sistem memeriksa apakah aplikasi sehat dengan mengirim permintaan HEAD atau GET yang mensimulasikan kunjungan browser. HTTPS: Sistem memeriksa apakah aplikasi sehat dengan mengirim permintaan HEAD atau GET yang mensimulasikan kunjungan browser. Data dienkripsi, yang lebih aman daripada HTTP. TCP: Sistem memverifikasi bahwa port terbuka dengan mengirim paket SYN. gRPC: Sistem memeriksa apakah aplikasi sehat dengan mengirim permintaan POST atau GET.	HTTP
HealthCheckTimeout	integer	No	Periode timeout, dalam detik, untuk respons health check. Jika server backend gagal merespons dalam periode ini, health check gagal. Nilai yang valid: 1 hingga 300. Catatan Parameter ini hanya berlaku ketika HealthCheckEnabled diatur ke true.	3
HealthyThreshold	integer	No	Jumlah health check berturut-turut yang berhasil yang diperlukan agar status server berubah dari fail menjadi success. Nilai yang valid: 2 hingga 10.	4
UnhealthyThreshold	integer	No	Jumlah health check berturut-turut yang gagal yang diperlukan agar status server berubah dari success menjadi fail. Nilai yang valid: 2 hingga 10.	4
StickySessionConfig	object	No	Pengaturan sticky session.
Cookie	string	No	Cookie yang dikonfigurasi pada server. Cookie harus terdiri dari 1 hingga 200 karakter dan terdiri dari karakter ASCII. Tidak boleh berisi tanda koma (,), titik koma (;), atau spasi, dan tidak boleh dimulai dengan tanda dolar ($). Catatan Parameter ini hanya berlaku ketika StickySessionEnabled diatur ke true dan StickySessionType diatur ke Server.	B490B5EBF6F3CD402E515D22B******
CookieTimeout	integer	No	Periode timeout cookie, dalam detik. Nilai yang valid: 1 hingga 86400. Catatan Parameter ini hanya berlaku ketika StickySessionEnabled diatur ke true dan StickySessionType diatur ke Insert.	1000
StickySessionEnabled	boolean	No	Menentukan apakah akan mengaktifkan sticky session. Nilai yang valid: true: Mengaktifkan sticky session. false: Menonaktifkan sticky session.	false
StickySessionType	string	No	Metode yang digunakan untuk menangani cookie. Nilai yang valid: Insert: Load balancer menyisipkan cookie (SERVERID) ke dalam respons HTTP atau HTTPS untuk permintaan pertama dari klien. Permintaan berikutnya dari klien yang berisi cookie ini akan dirutekan ke server backend yang sama. Server: Load balancer menimpa cookie asli ketika mendeteksi cookie yang ditentukan pengguna. Permintaan berikutnya dari klien yang berisi cookie baru akan dirutekan ke server backend yang sama. Catatan Parameter ini hanya berlaku ketika StickySessionEnabled diatur ke true.	Insert
ServerGroupId	string	Yes	ID grup server.	sgp-atstuj3rtop****
UpstreamKeepaliveEnabled	boolean	No	Menentukan apakah akan mengaktifkan koneksi persisten ke server backend. true: Mengaktifkan koneksi persisten. false: Menonaktifkan koneksi persisten.	sgp-123
ServiceName	string	No	Nama dari `Service` Kubernetes (K8s) yang sesuai. Parameter ini hanya berlaku untuk skenario Application Load Balancer (ALB) Ingress.	test2
UchConfig	object	No	Pengaturan untuk consistent hashing berbasis URL.
Type	string	Yes	Tipe parameter. Hanya `QueryString` yang didukung.	QueryString
Value	string	Yes	Nama parameter query string yang akan digunakan untuk consistent hashing.	abc
ConnectionDrainConfig	object	No	Pengaturan connection draining. Jika connection draining diaktifkan, load balancer memperbolehkan koneksi yang ada untuk diproses selama periode waktu yang ditentukan setelah server backend dihapus atau dinyatakan tidak sehat. Catatan Instans Basic tidak mendukung connection draining. Hanya instans Standard dan WAF-enhanced yang mendukung fitur ini. Grup server tipe instance dan IP mendukung connection draining. Grup server tipe Function Compute tidak.
ConnectionDrainEnabled	boolean	No	Menentukan apakah akan mengaktifkan connection draining. true: Mengaktifkan connection draining. false: Menonaktifkan connection draining.	false
ConnectionDrainTimeout	integer	No	Periode timeout connection draining, dalam detik. Nilai yang valid: 0 hingga 900.	300
SlowStartConfig	object	No	Pengaturan slow start. Jika Anda mengaktifkan slow start, load balancer memanaskan server backend yang baru ditambahkan selama periode yang ditentukan. Selama periode pemanasan ini, jumlah permintaan yang dirutekan ke server meningkat secara linear. Catatan Instans Basic tidak mendukung slow start. Hanya instans Standard dan WAF-enhanced yang mendukung fitur ini. Grup server tipe instance dan IP mendukung slow start. Grup server tipe Function Compute tidak. Slow start hanya dapat diaktifkan ketika algoritma penjadwalan adalah weighted round robin.
SlowStartEnabled	boolean	No	Menentukan apakah akan mengaktifkan slow start. true: Mengaktifkan slow start. false: Menonaktifkan slow start.	false
SlowStartDuration	integer	No	Durasi periode slow start, dalam detik. Nilai yang valid: 30 hingga 900.	30
CrossZoneEnabled	boolean	No	Menentukan apakah akan mengaktifkan cross-zone load balancing untuk grup server. Nilai yang valid: true (default): Mengaktifkan cross-zone load balancing. false: Menonaktifkan cross-zone load balancing. Catatan Instans Basic mengharuskan cross-zone load balancing diaktifkan. Opsi untuk menonaktifkannya hanya didukung oleh instans Standard dan WAF-enhanced. Grup server tipe instance dan IP mendukung penonaktifan cross-zone load balancing. Grup server tipe Function Compute tidak. Sticky session tidak dapat diaktifkan ketika cross-zone load balancing dinonaktifkan.	true
IpVersionAffinityMode	string	No	Mode afinitas versi IP.	Affinity

Elemen respons

Element	Type	Description	Example
	object	Data respons.
JobId	string	ID dari task 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.