All Products
Search

This Product

    Server Load Balancer:UpdateServerGroupAttribute

    Document Center

    Server Load Balancer:UpdateServerGroupAttribute

    Last Updated:Jul 14, 2026

    Memperbarui konfigurasi kelompok server Network Load Balancer (NLB).

    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:UpdateServerGroupAttribute

    update

    *ServerGroup

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ServerGroupId

    string

    Yes

    ID kelompok server.

    sgp-atstuj3rtoptyui****
    ServerGroupName

    string

    No

    Nama baru 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_ServerGroup1
    ConnectionDrainEnabled

    boolean

    No

    Apakah akan mengaktifkan pengurasan koneksi. Nilai valid:

    • true: Diaktifkan.

    • false: 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: weighted round-robin. Server backend dengan bobot lebih tinggi menerima lebih banyak permintaan daripada yang memiliki bobot lebih rendah.

    • Wlc: weighted least connections. Permintaan didistribusikan berdasarkan bobot dan jumlah koneksi ke server backend. Jika dua server backend memiliki bobot yang sama, server backend yang memiliki lebih sedikit koneksi diharapkan menerima lebih banyak permintaan.

    • 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. Ini adalah consistent hashing berdasarkan empat elemen (alamat IP sumber, alamat IP tujuan, port sumber, dan port tujuan). Permintaan dari 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
    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 tanpa memandang 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
    PreserveClientIpEnabled

    boolean

    No

    Apakah akan mengaktifkan pelestarian IP klien. Nilai valid:

    • true: Diaktifkan.

    • false: Dinonaktifkan.

    Catatan

    Jika PreserveClientIpEnabled diatur ke false dan kelompok server dikaitkan dengan pendengar TCPSSL, Anda tidak dapat mengubah nilai parameter ini menjadi true.

    false
    HealthCheckConfig

    object

    No

    Konfigurasi pemeriksaan kesehatan.

    HealthCheckEnabled

    boolean

    No

    Apakah akan mengaktifkan pemeriksaan kesehatan. Nilai valid:

    • true: Diaktifkan.

    • false: Dinonaktifkan.

    false
    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 0 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 (dari fail ke success). Nilai valid: 2 hingga 10.

    3
    UnhealthyThreshold

    integer

    No

    Jumlah pemeriksaan kesehatan gagal berturut-turut yang harus terjadi sebelum server backend dinyatakan tidak sehat (dari success ke fail). Nilai valid: 2 hingga 10.

    3
    HealthCheckConnectTimeout

    integer

    No

    Periode waktu tunggu maksimum untuk tanggapan pemeriksaan kesehatan. Unit: detik. Nilai valid: 1 hingga 300. Nilai default: 5.

    100
    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 pribadi server backend.

    • domain: nama domain tertentu. Panjang nama domain harus 1 hingga 80 karakter, dan hanya dapat berisi huruf kecil, 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 -/.%?#&= dan karakter extended _;~!（)*[]@$^:',+. 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 atau HEAD.

    Catatan

    Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.

    GET
    HealthCheckReq

    string

    No

    String permintaan untuk pemeriksaan kesehatan pendengar UDP. String hanya dapat berisi huruf dan angka, dengan panjang maksimum 512 karakter.

    hello
    HealthCheckExp

    string

    No

    String tanggapan 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 atau HTTP1.1.

    Catatan

    Parameter ini hanya berlaku jika HealthCheckType diatur ke HTTP.

    HTTP1.0
    RegionId

    string

    No

    ID wilayah instans Network Load Balancer (NLB).

    Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.

    cn-hangzhou
    DryRun

    boolean

    No

    Apakah akan melakukan dry run. Nilai valid:

    • true: melakukan dry run. Sistem memeriksa parameter wajib, sintaks permintaan, dan aturan bisnis. Jika pemeriksaan gagal, kesalahan yang sesuai dikembalikan. Jika pemeriksaan berhasil, kode kesalahan DryRunOperation dikembalikan.

    • false (default): melakukan dry run dan mengirim permintaan. Jika pemeriksaan berhasil, 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 nilai, tetapi Anda harus memastikan bahwa nilai tersebut unik di antara permintaan yang berbeda. Token klien hanya dapat berisi karakter ASCII.

    Catatan

    Jika Anda tidak mengatur parameter ini, sistem menggunakan RequestId sebagai ClientToken. Nilai RequestId mungkin berbeda untuk setiap permintaan API.

    123e4567-e89b-12d3-a456-426655440000

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Tanggapan untuk memperbarui konfigurasi 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

    Description
    400 IllegalParam.%s The param of %s is illegal.
    400 SystemBusy System is busy, please try again later.
    400 IllegalParam.healthCheckDomain The parameter of healthCheckConfig.healthCheckDomain is illegal.
    400 IlleagalParam.healthCheckUrl The parameter of healthCheckUrl in healthCheckConfig is illegal.
    400 OperationDenied.UidNotAllowQuic29 The operation is not allowed because of uid not allow quic29 version.
    400 IllegalParam The param of %s is illegal.
    400 DryRunOperation Request validation has been passed with DryRun flag set.
    400 IllegalParam.ServerGroupName The param of ServerGroupName is illegal.
    400 IllegalParam.PreserveClientIpSwitch The server group associated with the tcpssl listener does not support enabling PreserveClientIp.
    403 Forbidden.NoPermission Authentication is failed for NoPermission.
    404 ResourceNotFound.serverGroup The specified resource of serverGroup is not found.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.