全部产品
Search

搜索本产品

    Server Load Balancer：UpdateListenerAttribute

    文档中心

    Server Load Balancer：UpdateListenerAttribute

    更新时间：Dec 19, 2025

    Memperbarui atribut listener, seperti nama listener dan aksi default.

    Deskripsi operasi

    Operasi UpdateListenerAttribute bersifat asinkron. Setelah Anda mengirim permintaan, sistem akan mengembalikan ID permintaan dan menjalankan tugas di latar belakang. Konfigurasi listener tidak diperbarui secara langsung. Anda dapat memanggil operasi GetListenerAttribute untuk memeriksa status pembaruan listener:

    • Jika listener berada dalam status Configuring, listener sedang diperbarui.

    • Jika listener berada dalam status Running, listener telah diperbarui.

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

    update

    *LoadBalancer

    acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

    *SecurityPolicy

    acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

    *ServerGroup

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ListenerId

    string

    Yes

    ID listener Application Load Balancer (ALB).

    lsn-o4u54y73wq7b******
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan.

    Token harus unik di antara permintaan dan hanya boleh berisi karakter ASCII.

    Catatan

    Jika Anda tidak menentukan parameter ini, sistem menggunakan RequestId dari permintaan sebagai ClientToken. RequestId setiap permintaan API mungkin berbeda.

    5A2CFF0E-5718-45B5-9D4D-70B******
    DryRun

    boolean

    No

    Menentukan apakah akan melakukan dry run. Nilai yang valid:

    • true: melakukan dry run. Sistem memeriksa parameter yang diperlukan, format permintaan, dan batas layanan. Jika permintaan gagal dalam dry run, pesan kesalahan dikembalikan. Jika permintaan lolos dry run, sistem mengembalikan kode kesalahan DryRunOperation.

    • false (default): melakukan permintaan normal. Jika permintaan lolos pemeriksaan, sistem mengembalikan kode status HTTP 2xx dan menjalankan operasi.

    false
    ListenerDescription

    string

    No

    Nama listener.

    Nama harus terdiri dari 2 hingga 256 karakter dan dapat berisi huruf, angka, karakter Tionghoa, koma (,), titik (.), titik koma (;), garis miring (/), tanda at (@), garis bawah (_), dan tanda hubung (-).

    HTTP_80
    RequestTimeout

    integer

    No

    Periode timeout permintaan. Satuan: detik. Nilai yang valid: 1 hingga 180.

    Jika tidak ada respons yang diterima dari server backend selama periode timeout, ALB mengirimkan kode kesalahan HTTP 504 ke klien.

    3
    IdleTimeout

    integer

    No

    Periode timeout idle. Satuan: detik. Nilai yang valid: 1 hingga 60.

    Jika tidak ada permintaan yang diterima selama periode timeout, ALB menutup koneksi saat ini. Saat permintaan baru diterima, ALB membuat koneksi baru.

    15
    GzipEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan kompresi Gzip untuk mengompres jenis file tertentu. Nilai yang valid:

    • true

    • false

    true
    Http2Enabled

    boolean

    No

    Menentukan apakah akan mengaktifkan HTTP/2. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    true
    SecurityPolicyId

    string

    No

    Kebijakan keamanan. Kebijakan keamanan sistem dan kebijakan keamanan kustom didukung.

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    tls_cipher_policy_1_0
    CaEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan otentikasi timbal balik. Nilai yang valid:

    • true

    • false

    false
    XForwardedForConfig

    object

    No

    Konfigurasi header `X-Forwarded-For`.

    XForwardedForClientCertClientVerifyAlias

    string

    No

    Nama header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertClientVerifyEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_client-verify-alias_123456
    XForwardedForClientCertClientVerifyEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Clientcert-Clientverify untuk mengambil hasil verifikasi sertifikat klien. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    false
    XForwardedForClientCertFingerprintAlias

    string

    No

    Nama header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertFingerprintEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_finger-print-alias_123456
    XForwardedForClientCertFingerprintEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Clientcert-Fingerprint untuk mengambil sidik jari sertifikat klien. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    false
    XForwardedForClientCertIssuerDNAlias

    string

    No

    Nama header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertIssuerDNEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_issue-dn-alias_123456
    XForwardedForClientCertIssuerDNEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Clientcert-Issuerdn untuk mengambil informasi tentang penerbit sertifikat klien. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    false
    XForwardedForClientCertSubjectDNAlias

    string

    No

    Nama header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertSubjectDNEnabled diatur ke true.

    Nama harus terdiri dari 1 hingga 40 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-).

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    test_subject-dn-alias_123456
    XForwardedForClientCertSubjectDNEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Clientcert-Subjectdn untuk mengambil informasi tentang pemilik sertifikat klien. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    false
    XForwardedForClientSrcPortEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Client-Srcport untuk mengambil port klien. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini tersedia untuk listener HTTP dan HTTPS.

    false
    XForwardedForEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-For untuk mengambil alamat IP asli klien. Nilai yang valid:

    • true (default)

    • false

    Catatan

    1. Jika Anda mengatur parameter ini ke true, nilai default XForwardedForProcessingMode adalah append. Anda dapat mengubah nilainya menjadi remove.

    2. Jika Anda mengatur parameter ini ke false, header X-Forwarded-For dipertahankan sebelum permintaan dikirim ke layanan backend. Tidak ada pemrosesan tambahan yang dilakukan.

    3. Parameter ini tersedia untuk listener HTTP dan HTTPS.

    true
    XForwardedForProcessingMode

    string

    No

    Mode pemrosesan header X-Forwarded-For. Parameter ini hanya berlaku jika XForwardedForEnabled diatur ke true. Nilai yang valid:

    • append (default): menambahkan alamat IP.

    • remove: menghapus alamat IP.

    Catatan

    1. Jika Anda mengatur parameter ini ke append, alamat IP hop terakhir ditambahkan ke header X-Forwarded-For sebelum permintaan dikirim ke layanan backend.

    2. Jika Anda mengatur parameter ini ke remove, header X-Forwarded-For dihapus sebelum permintaan dikirim ke layanan backend, terlepas dari apakah permintaan berisi header X-Forwarded-For atau tidak.

    3. Parameter ini tersedia untuk listener HTTP dan HTTPS.

    append
    XForwardedForProtoEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Proto untuk mengambil protokol listener instans ALB. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    XForwardedForSLBIdEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header SLB-ID untuk mengambil ID instans ALB. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    XForwardedForSLBPortEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Port untuk mengambil port listener instans ALB. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    XForwardedForClientSourceIpsEnabled

    boolean

    No

    Menentukan apakah ALB diizinkan untuk menemukan alamat IP asli klien dari header `X-Forwarded-For`. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini tersedia untuk listener HTTP dan HTTPS.

    false
    XForwardedForClientSourceIpsTrusted

    string

    No

    Alamat IP proksi tepercaya.

    ALB melintasi header X-Forwarded-For dari akhir ke awal. ALB memilih alamat IP pertama yang tidak termasuk dalam daftar alamat IP tepercaya sebagai alamat IP asli klien. Alamat IP ini digunakan untuk pembatasan kecepatan.

    10.1.1.0/24
    XForwardedForHostEnabled

    boolean

    No

    Menentukan apakah akan menggunakan header X-Forwarded-Host untuk mengambil nama domain yang digunakan klien untuk mengakses instans ALB. Nilai yang valid:

    • true

    • false (default)

    Catatan

    Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.

    false
    QuicConfig

    object

    No

    Konfigurasi asosiasi listener QUIC.

    QuicListenerId

    string

    No

    ID listener QUIC yang akan diasosiasikan. Parameter ini wajib jika QuicUpgradeEnabled diatur ke true. Parameter ini hanya tersedia untuk listener HTTPS.

    Catatan

    Listener asli dan listener QUIC yang diasosiasikan harus berada dalam instans ALB yang sama. Listener QUIC tidak boleh diasosiasikan dengan listener lain.

    lsn-333
    QuicUpgradeEnabled

    boolean

    No

    Menentukan apakah akan mengaktifkan peningkatan QUIC. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya tersedia untuk listener HTTPS.

    false
    Certificates

    array<object>

    No

    Sertifikat.

    object

    No

    Sertifikat.

    CertificateId

    string

    No

    ID sertifikat default. Anda hanya dapat menambahkan satu sertifikat server default.

    Catatan

    123157******
    CaCertificates

    array<object>

    No

    Sertifikat CA. Anda hanya dapat menentukan satu sertifikat CA.

    object

    No

    Sertifikat CA.

    CertificateId

    string

    No

    ID sertifikat CA.

    Catatan

    Parameter ini wajib jika CaEnabled diatur ke true.

    123359******
    DefaultActions

    array<object>

    No

    Aksi default untuk aturan pengalihan.

    array<object>

    No

    Aksi default.

    ForwardGroupConfig

    object

    No

    Konfigurasi aksi pengalihan. Parameter ini wajib dan hanya berlaku jika Type diatur ke ForwardGroup. Anda dapat menentukan maksimal 20 aksi pengalihan.

    ServerGroupTuples

    array<object>

    Yes

    Grup server tempat permintaan dialihkan.

    object

    No

    Grup server.

    ServerGroupId

    string

    Yes

    ID grup server tempat permintaan dialihkan.

    sgp-i5qt20******
    Type

    string

    Yes

    Jenis aksi. Anda hanya dapat menentukan satu jenis aksi.

    Atur nilainya ke ForwardGroup. Ini mengalihkan permintaan ke beberapa grup server.

    ForwardGroup

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Tanggapan.

    JobId

    string

    ID tugas asinkron.

    72dcd26b-f12d-4c27-b3af-18f6aed5****
    RequestId

    string

    ID permintaan.

    365F4154-92F6-4AE4-92F8-7FF******

    Contoh

    Respons sukses

    JSONformat

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

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 IncorrectStatus.LoadBalancer The status of %s [%s] is incorrect.
    400 IncorrectBusinessStatus.LoadBalancer The business status of %s [%s]  is incorrect. The business status of %s [%s]  is incorrect.
    400 IncorrectStatus.Listener The status of %s [%s] is incorrect.
    400 OperationDenied.CrossLoadBalancerQUICListener The operation is not allowed because of %s. The operation is not allowed because of %s.
    400 ResourceAlreadyAssociated.Listener The specified resource %s is already associated. The specified resource %s is already associated.
    400 OperationDenied.GRPCServerGroup The operation is not allowed because of %s.
    400 ResourceAlreadyAssociated.Certificate The specified resource %s is already associated.
    400 ResourceQuotaExceeded.SecurityPolicyAttachedNum The quota of %s is exceeded for resource %s, usage %s/%s. The quota of %s is exceeded for resource %s. Usage: %s/%s.
    400 ResourceQuotaExceeded.ServerGroupAttachedNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 ResourceQuotaExceeded.LoadBalancerServersNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 ResourceQuotaExceeded.ServerAddedNum The quota of %s is exceeded for resource %s, usage %s/%s.
    400 OperationDenied.ServerGroupProtocolNotSupport The operation is not allowed because of ServerGroupProtocolNotSupport. The operation is not allowed because the server group protocol is not supported.
    400 UnsupportedFeature.FullTraceHttps The feature of FullTraceHttps is not supported for current instance.
    400 ResourceInConfiguring.Listener The specified resource of %s is being configured, please try again later. The specified resource of %s is being configured, please try again later.
    400 Mismatch.VpcId The %s is mismatched for %s and %s. The %s is mismatched for %s and %s.
    400 InvalidParameter Invalid parameter, please check the parameter input. Invalid parameter, please check the parameter input.
    403 Forbidden.LoadBalancer Authentication is failed for %s. Authentication is failed for %s.
    404 ResourceNotFound.Listener The specified resource %s is not found.
    404 ResourceNotFound.ServerGroup The specified resource %s is not found.
    404 ResourceNotFound.SecurityPolicy The specified resource %s is not found. The specified resource %s is not found.
    404 ResourceNotFound.Certificate The specified resource %s is not found. The specified resource %s is not found.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.