Perbarui atribut listener menggunakan UpdateListenerAttribute-Server Load Balancer-Alibaba Cloud - Server Load Balancer

Memperbarui konfigurasi pendengar, seperti nama dan aksi default.

Deskripsi operasi

UpdateListenerAttribute adalah operasi asinkron. Setelah ID permintaan dikembalikan, pembaruan konfigurasi pendengar masih diproses di latar belakang. Anda dapat memanggil GetListenerAttribute untuk mengkueri status pembaruan konfigurasi pendengar:

Jika pendengar berada dalam status Configuring, konfigurasi pendengar sedang diperbarui.
Jika pendengar berada dalam status Running, konfigurasi pendengar 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

Parameter permintaan

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	ID pendengar dari instans Application Load Balancing (ALB).	lsn-o4u54y73wq7b******
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara berbagai permintaan. Token hanya dapat berisi karakter ASCII. Catatan Jika Anda tidak menentukan parameter ini, sistem secara otomatis menggunakan RequestId sebagai ClientToken. RequestId mungkin berbeda untuk setiap permintaan API.	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	No	Apakah akan menjalankan dry run saja, tanpa menjalankan permintaan aktual. Nilai valid: true: Hanya menjalankan dry run. Sistem memeriksa permintaan untuk potensi masalah, termasuk nilai parameter yang hilang, sintaksis permintaan yang salah, dan batas layanan. Jika permintaan gagal dalam dry run, kode kesalahan dikembalikan. Jika permintaan lulus dry run, kode kesalahan `DryRunOperation` dikembalikan. false (default): Menjalankan dry run dan menjalankan permintaan aktual. Jika permintaan lulus dry run, kode status `HTTP 2xx` dikembalikan dan operasi dijalankan.	false
ListenerDescription	string	No	Nama kustom pendengar. Panjang nama harus 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 waktu tunggu permintaan. Unit: detik. Nilai valid: 1 hingga 600. Jika tidak ada tanggapan yang diterima dari server backend dalam periode waktu tunggu, load balancing mengembalikan kode kesalahan `HTTP 504` ke klien.	60
IdleTimeout	integer	No	Periode waktu tunggu koneksi idle. Unit: detik. Nilai valid: 1 hingga 600. Jika tidak ada permintaan akses yang diterima dalam periode waktu tunggu, load balancing memutuskan sementara koneksi saat ini dan memulihkan koneksi ketika permintaan berikutnya tiba.	15
GzipEnabled	boolean	No	Apakah akan mengaktifkan kompresi Gzip untuk mengompresi jenis file tertentu. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	true
Http2Enabled	boolean	No	Apakah akan mengaktifkan HTTP/2. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	true
SecurityPolicyId	string	No	Kebijakan keamanan. Kebijakan keamanan sistem dan kebijakan keamanan kustom didukung. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	tls_cipher_policy_1_0
CaEnabled	boolean	No	Apakah akan mengaktifkan otentikasi timbal balik. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	false
XForwardedForConfig	object	No	Konfigurasi fitur XForwardedFor.
XForwardedForClientCertClientVerifyAlias	string	No	Nama bidang Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertClientVerifyEnabled diatur ke true. Panjang nama harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan angka. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Clientcert-clientverify` untuk mengambil hasil verifikasi sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	false
XForwardedForClientCertFingerprintAlias	string	No	Nama bidang Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertFingerprintEnabled diatur ke true. Panjang nama harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan angka. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Clientcert-fingerprint` untuk mengambil sidik jari sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	false
XForwardedForClientCertIssuerDNAlias	string	No	Nama bidang Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertIssuerDNEnabled diatur ke true. Panjang nama harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan angka. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Clientcert-issuerdn` untuk mengambil informasi penerbit sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	false
XForwardedForClientCertSubjectDNAlias	string	No	Nama bidang Header Kustom. Parameter ini berlaku hanya jika XForwardedForClientCertSubjectDNEnabled diatur ke true. Panjang nama harus 1 hingga 40 karakter, dan dapat berisi huruf kecil a hingga z, tanda hubung (-), garis bawah (_), dan angka. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Clientcert-subjectdn` untuk mengambil informasi pemilik sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Hanya pendengar HTTPS yang mendukung parameter ini.	false
XForwardedForClientSrcPortEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Client-srcport` untuk mengambil Port klien yang mengakses instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Pendengar HTTP dan HTTPS mendukung parameter ini.	false
XForwardedForEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-For` untuk mengambil alamat IP asli klien. Nilai valid: true (default): Diaktifkan. false: Dinonaktifkan. Catatan Jika Anda mengatur parameter ini ke true, XForwardedForProcessingMode secara default menjadi append dan dapat diubah menjadi remove. Jika Anda mengatur parameter ini ke false, bidang Header Kustom `X-Forwarded-For` dipertahankan tanpa pemrosesan tambahan sebelum permintaan dikirim ke server backend. Pendengar HTTP dan HTTPS mendukung parameter ini.	true
XForwardedForProcessingMode	string	No	Mode pemrosesan untuk bidang Header Kustom `X-Forwarded-For`. Parameter ini berlaku hanya jika XForwardedForEnabled diatur ke true. Nilai valid: append (default): Menambahkan. remove: Menghapus. Catatan Jika Anda mengatur parameter ini ke append, alamat IP hop terakhir ditambahkan ke bidang Header Kustom `X-Forwarded-For` sebelum permintaan dikirim ke server backend. Jika Anda mengatur parameter ini ke remove, header `X-Forwarded-For` dihapus sebelum permintaan dikirim ke server backend, terlepas dari apakah permintaan berisi bidang Header Kustom `X-Forwarded-For`. Pendengar HTTP dan HTTPS mendukung parameter ini.	append
XForwardedForProtoEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Proto` untuk mengambil protokol pendengar dari instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini.	false
XForwardedForSLBIdEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `SLB-ID` untuk mengambil ID instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini.	false
XForwardedForSLBPortEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Port` untuk mengambil Port pendengar dari instans load balancing. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini.	false
XForwardedForClientSourceIpsEnabled	boolean	No	Apakah akan mengizinkan ALB untuk mengambil alamat IP klien asli dari bidang Header Kustom X-Forwarded-For. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Pendengar HTTP dan HTTPS mendukung parameter ini.	false
XForwardedForClientSourceIpsTrusted	string	No	Alamat IP proxy tepercaya. Application Load Balancing (ALB) menelusuri bidang header `X-Forwarded-For` dari kanan ke kiri dan memilih alamat IP pertama yang tidak ada dalam daftar IP tepercaya sebagai alamat IP klien asli. Alamat IP ini digunakan untuk pembatasan laju berbasis IP sumber.	10.1.1.0/24
XForwardedForHostEnabled	boolean	No	Apakah akan menggunakan bidang Header Kustom `X-Forwarded-Host` untuk mengambil nama domain klien yang mengakses instans load balancing. Nilai valid: true: Diaktifkan. false (default): Dinonaktifkan. Catatan Pendengar HTTP, HTTPS, dan QUIC mendukung parameter ini.	false
QuicConfig	object	No	Informasi konfigurasi ketika pendengar QUIC terkait diaktifkan.
QuicListenerId	string	No	ID pendengar QUIC yang akan diasosiasikan. Parameter ini diperlukan ketika QuicUpgradeEnabled diatur ke true. Parameter ini hanya valid untuk pendengar HTTPS. Catatan Pendengar asli dan pendengar QUIC yang diasosiasikan harus berada dalam instans ALB yang sama, dan pendengar QUIC tidak boleh telah diasosiasikan sebelumnya.	lsn-333
QuicUpgradeEnabled	boolean	No	Apakah akan mengaktifkan peningkatan QUIC. Nilai valid: true: Diaktifkan. false: Dinonaktifkan. Catatan Parameter ini hanya valid untuk pendengar HTTPS.	false
Certificates	array<object>	No	Daftar sertifikat.
	object	No	Struktur sertifikat.
CertificateId	string	No	ID sertifikat default. Hanya satu sertifikat server default yang didukung. Catatan Parameter ini diperlukan ketika tipe protokol pendengar adalah HTTPS atau QUIC. Untuk menambahkan lebih banyak sertifikat server, panggil AssociateAdditionalCertificatesWithListener untuk mengonfigurasi sertifikat ekstensi setelah pendengar dibuat.	123157******
CaCertificates	array<object>	No	Daftar sertifikat CA. Hanya satu sertifikat CA yang didukung.
	object	No	Struktur sertifikat CA.
CertificateId	string	No	ID sertifikat CA. Catatan Parameter ini diperlukan ketika CaEnabled diatur ke true.	123359******
DefaultActions	array<object>	No	Daftar aksi aturan default.
	array<object>	No	Struktur aksi aturan default.
ForwardGroupConfig	object	No	Konfigurasi penerusan untuk aksi. Parameter ini wajib dan hanya valid jika Type diatur ke ForwardGroup. Anda dapat menambahkan hingga 20 konfigurasi aksi penerusan.
ServerGroupTuples	array<object>	Yes	Daftar tupel kelompok server tujuan penerusan.
	object	No	Struktur tupel kelompok server tujuan penerusan.
ServerGroupId	string	Yes	ID kelompok server tujuan tempat permintaan diteruskan.	sgp-i5qt20******
Type	string	Yes	Tipe aksi. Anda dapat menambahkan hingga satu tipe aksi. Nilai valid: ForwardGroup, yang menunjukkan bahwa permintaan diteruskan ke beberapa kelompok server.	ForwardGroup

Elemen respons

Element	Type	Description	Example
	object	Struktur 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.	Status Port instans saat ini tidak mendukung operasi ini.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	Status instans saat ini tidak mendukung operasi ini.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	Status Port Pendengar saat ini tidak mendukung operasi ini.
400	OperationDenied.CrossLoadBalancerQUICListener	The operation is not allowed because of %s.	Operasi ditolak karena %s.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.	Sumber daya %s sudah dikaitkan.
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.	Operasi ditolak karena pendengar yang terkait dengan kelompok server gRPC ini tidak mengaktifkan HTTP/2.0.
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.	Sertifikat sudah dikaitkan.
400	ResourceQuotaExceeded.SecurityPolicyAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	Kuota %s telah terlampaui. Resource adalah %s, penggunaan saat ini adalah %s, dan kuota adalah %s.
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	Jumlah asosiasi untuk kelompok server telah melebihi batas kuota.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	Jumlah server backend telah melebihi batas kuota.
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	Jumlah server yang ditambahkan ke kelompok server telah melebihi batas kuota.
400	OperationDenied.ServerGroupProtocolNotSupport	The operation is not allowed because of ServerGroupProtocolNotSupport.	Operasi ditolak karena protokol kelompok server tidak didukung.
400	UnsupportedFeature.FullTraceHttps	The feature of FullTraceHttps is not supported for current instance.	Edisi instans saat ini tidak mendukung fitur HTTPS end-to-end.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.	Sumber daya %s yang ditentukan sedang dikonfigurasi. Coba lagi nanti.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	%s tidak cocok antara %s dan %s.
400	InvalidParameter	Invalid parameter, please check the parameter input.	Parameter tidak valid. Periksa input parameter.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.	Sertifikat CA rusak.
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Otentikasi gagal untuk operasi load balancing.
404	ResourceNotFound.Listener	The specified resource %s is not found.	Pendengar tidak ada.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.	Kelompok server backend tidak ada.
404	ResourceNotFound.SecurityPolicy	The specified resource %s is not found.	Resource %s tidak ada.
404	ResourceNotFound.Certificate	The specified resource %s is not found.	Sertifikat yang ditentukan tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.