Referensi API GetListenerAttribute untuk Listener ALB - Application Load Balancer - Alibaba Cloud - Server Load Balancer

Mengkueri detail Pendengar.

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

get

*LoadBalancer.

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

acs:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ListenerId	string	Yes	ID Pendengar.	lsn-o4u54y73wq7b******

Elemen respons

Element	Type	Description	Example
	object	Informasi detail tentang Pendengar.
AclConfig	object	Struktur konfigurasi ACL.
AclRelations	array<object>	ID kebijakan kontrol akses yang terkait dengan Pendengar.
	object	Struktur kebijakan kontrol akses yang terkait dengan Pendengar.
AclId	string	ID kebijakan kontrol akses yang terkait dengan Pendengar.	acl-doc****
Status	string	Status asosiasi antara ACL dan Pendengar. Nilai valid: Associating: ACL sedang diasosiasikan. Associated: ACL telah diasosiasikan. Dissociating: ACL sedang dilepas.	Associating
AclType	string	Tipe kontrol akses. Nilai valid: White: Hanya permintaan dari alamat IP atau blok CIDR yang dikonfigurasi di ACL yang dipilih yang akan diteruskan. Daftar putih berlaku untuk skenario di mana aplikasi hanya mengizinkan akses dari alamat IP tertentu. Mengonfigurasi daftar putih menimbulkan risiko bisnis. Setelah daftar putih dikonfigurasi, hanya permintaan dari alamat IP di daftar putih yang dapat mengakses Pendengar load balancing. Jika Anda mengaktifkan akses daftar putih tetapi tidak menambahkan alamat IP apa pun ke ACL, Pendengar load balancing akan meneruskan semua permintaan. Black: Tidak ada permintaan dari alamat IP atau blok CIDR yang dikonfigurasi di ACL yang dipilih yang akan diteruskan. Blacklist berlaku untuk skenario di mana aplikasi memblokir akses dari alamat IP tertentu. Jika Anda mengaktifkan akses blacklist tetapi tidak menambahkan alamat IP apa pun ke ACL, Pendengar load balancing akan meneruskan semua permintaan.	White
CaCertificates	array<object>	Daftar sertifikat CA.
	object
CertificateId	string	ID sertifikat CA.	139a00*****
IsDefault	boolean	Apakah sertifikat merupakan sertifikat default. Nilai valid: true: Ya. false: Tidak.	true
Status	string	Status sertifikat.	Associated
CaEnabled	boolean	Apakah otentikasi timbal balik diaktifkan. Nilai valid: true: Ya. false: Tidak.	false
Certificates	array<object>	Daftar sertifikat.
	object	Struktur sertifikat.
CertificateId	string	ID sertifikat. Hanya sertifikat server yang didukung.	123157*******
DefaultActions	array<object>	Daftar aksi aturan default.
	array<object>	Struktur aksi aturan default.
ForwardGroupConfig	object	Konfigurasi aksi penerusan. Parameter ini hanya berlaku ketika tipe aksi adalah ForwardGroup.
ServerGroupTuples	array<object>	Kelompok server tujuan untuk penerusan.
	object	Kelompok server tujuan untuk penerusan.
ServerGroupId	string	ID kelompok server tujuan.	sgp-i5qt20******
Type	string	Tipe aksi. Nilai valid: ForwardGroup, yang menunjukkan bahwa permintaan diteruskan ke beberapa kelompok server.	ForwardGroup
GzipEnabled	boolean	Apakah kompresi Gzip diaktifkan untuk mengompresi tipe file tertentu. Nilai valid: true: Ya. false: Tidak.	true
Http2Enabled	boolean	Apakah HTTP/2 diaktifkan. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini hanya didukung oleh Pendengar HTTPS.	true
IdleTimeout	integer	Menentukan periode waktu tunggu koneksi idle. Unit: detik. Jika tidak ada permintaan yang diterima dalam periode waktu tunggu, load balancer akan menutup koneksi saat ini secara sementara dan membuat koneksi baru ketika permintaan berikutnya tiba.	2
ListenerDescription	string	Nama kustom Pendengar.	HTTP_80
ListenerId	string	ID Pendengar.	lsn-o4u54y73wq7b******
ListenerPort	integer	Port antarmuka depan yang digunakan oleh load balancer.	80
ListenerProtocol	string	Protokol Pendengar. Nilai valid: HTTP, HTTPS, dan QUIC.	HTTP
ListenerStatus	string	Status Pendengar saat ini. Nilai valid: Provisioning: Pendengar sedang dibuat. Running: Pendengar sedang berjalan. Configuring: Pendengar sedang dikonfigurasi. Stopped: Pendengar dihentikan.	Running
LoadBalancerId	string	ID instans ALB.	alb-bd6oylbckp6k9x****
LogConfig	object	Informasi konfigurasi log.
AccessLogRecordCustomizedHeadersEnabled	boolean	Apakah bidang header kustom disertakan dalam log akses. Nilai valid: true: Ya. false: Tidak.	true
AccessLogTracingConfig	object	Informasi konfigurasi Xtrace untuk log akses.
TracingEnabled	boolean	Status fitur Xtrace. Nilai valid: true: Ya. false: Tidak. Catatan Anda hanya dapat mengatur parameter ini ke true ketika fitur log akses (AccessLogEnabled) diaktifkan untuk instans.	true
TracingSample	integer	Laju pengambilan sampel untuk Xtrace. Nilai valid: 1 hingga 10000. Catatan Parameter ini hanya berlaku ketika TracingEnabled diatur ke true.	100
TracingType	string	Tipe Xtrace. Nilai valid: Zipkin. Catatan Parameter ini hanya berlaku ketika TracingEnabled diatur ke true.	Zipkin
QuicConfig	object	Informasi konfigurasi untuk mengasosiasikan Pendengar QUIC.
QuicListenerId	string	ID Pendengar QUIC yang akan diasosiasikan. Parameter ini wajib diisi ketika QuicUpgradeEnabled diatur ke true. Parameter ini hanya berlaku untuk Pendengar HTTPS. Catatan Pendengar asli dan Pendengar QUIC yang diasosiasikan harus berada pada instans ALB yang sama, dan Pendengar QUIC tidak boleh pernah diasosiasikan sebelumnya.	lsn-ek6ad66t****
QuicUpgradeEnabled	boolean	Apakah peningkatan QUIC diaktifkan. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini hanya berlaku untuk Pendengar HTTPS.	true
RequestId	string	ID permintaan.	365F4154-92F6-4AE4-92F8-7FF******
RequestTimeout	integer	Menentukan periode waktu tunggu permintaan. Unit: detik. Jika server backend tidak mengirimkan tanggapan dalam periode waktu tunggu, load balancer akan berhenti menunggu dan mengembalikan kode kesalahan `HTTP 504` ke klien.	34
SecurityPolicyId	string	Kebijakan keamanan. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	tls_cipher_policy_1_1
Tags	array<object>	Tag.
	object	Struktur tag.
Key	string	Kunci tag. Panjangnya dapat mencapai 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`.	env
Value	string	Nilai tag. Panjangnya dapat mencapai 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`.	product
XForwardedForConfig	object	Konfigurasi bidang X-Forwarded-For.
XForwardedForClientCertClientVerifyAlias	string	Nama Header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertClientVerifyEnabled diatur ke true. Nama harus memiliki panjang 1 hingga 40 karakter dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Clientcert-clientverify` untuk mengambil hasil verifikasi sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	true
XForwardedForClientCertFingerprintAlias	string	Nama Header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertFingerprintEnabled diatur ke true. Nama harus memiliki panjang 1 hingga 40 karakter dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Clientcert-fingerprint` untuk mengambil sidik jari sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	true
XForwardedForClientCertIssuerDNAlias	string	Nama Header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertIssuerDNEnabled diatur ke true. Nama harus memiliki panjang 1 hingga 40 karakter dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Clientcert-issuerdn` untuk mengambil informasi penerbit sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	true
XForwardedForClientCertSubjectDNAlias	string	Nama Header kustom. Parameter ini hanya berlaku jika XForwardedForClientCertSubjectDNEnabled diatur ke true. Nama harus memiliki panjang 1 hingga 40 karakter dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Clientcert-subjectdn` untuk mengambil informasi subjek sertifikat klien yang mengakses instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini hanya didukung oleh pendengar HTTPS.	true
XForwardedForClientSourceIpsEnabled	boolean	Apakah akan mengizinkan Application Load Balancer (ALB) untuk mengambil alamat IP klien aktual dari bidang Header `X-Forwarded-For`. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini didukung oleh pendengar HTTP dan HTTPS.	false
XForwardedForClientSourceIpsTrusted	string	Alamat IP proxy tepercaya. Application Load Balancer (ALB) menelusuri bidang header `X-Forwarded-For` dari belakang ke depan dan memilih alamat IP pertama yang tidak ada dalam daftar alamat IP tepercaya sebagai alamat IP klien aktual. Alamat IP ini digunakan untuk pembatasan laju berbasis alamat IP sumber.	10.1.1.0/24
XForwardedForClientSrcPortEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Client-Port` untuk mengambil Port klien yang mengakses instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini didukung oleh pendengar HTTP dan HTTPS.	true
XForwardedForEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-For` untuk mengambil alamat IP aktual klien. Nilai valid: true (default): Ya. false: Tidak. Catatan Jika Anda mengatur parameter ini ke true, nilai default XForwardedForProcessingMode adalah append, dan Anda dapat mengubahnya menjadi remove. Jika Anda mengatur parameter ini ke false, bidang Header `X-Forwarded-For` dipertahankan tanpa pemrosesan tambahan sebelum permintaan diteruskan ke server backend. Parameter ini didukung oleh pendengar HTTP dan HTTPS.	true
XForwardedForHostEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Host` untuk mengambil nama domain klien yang mengakses instans load balancing. Nilai valid: true: Ya. false (default): Tidak. Catatan Parameter ini didukung oleh pendengar HTTP, HTTPS, dan QUIC.	false
XForwardedForProcessingMode	string	Mode pemrosesan untuk bidang Header `X-Forwarded-For`. Parameter ini hanya berlaku jika XForwardedForEnabled diatur ke true. Nilai valid: append (default): Menambahkan alamat IP hop terakhir ke bidang Header `X-Forwarded-For` sebelum permintaan diteruskan ke server backend. remove: Menghapus bidang Header `X-Forwarded-For` sebelum permintaan diteruskan ke server backend, terlepas dari apakah permintaan mengandung bidang Header `X-Forwarded-For`. Catatan Jika Anda mengatur parameter ini ke append, alamat IP hop terakhir ditambahkan ke bidang Header `X-Forwarded-For` sebelum permintaan diteruskan ke server backend. Jika Anda mengatur parameter ini ke remove, bidang Header `X-Forwarded-For` dihapus sebelum permintaan diteruskan ke server backend, terlepas dari apakah permintaan mengandung bidang Header `X-Forwarded-For`. Parameter ini didukung oleh pendengar HTTP dan HTTPS.	append
XForwardedForProtoEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Proto` untuk mengambil protokol pendengar instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini didukung oleh pendengar HTTP, HTTPS, dan QUIC.	true
XForwardedForSLBIdEnabled	boolean	Apakah akan menggunakan bidang Header `SLB-ID` untuk mengambil ID instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini didukung oleh pendengar HTTP, HTTPS, dan QUIC.	true
XForwardedForSLBPortEnabled	boolean	Apakah akan menggunakan bidang Header `X-Forwarded-Port` untuk mengambil Port pendengar instans load balancing. Nilai valid: true: Ya. false: Tidak. Catatan Parameter ini didukung oleh pendengar HTTP, HTTPS, dan QUIC.	true

Contoh

Respons sukses

JSONformat

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "CaCertificates": [
    {
      "CertificateId": "139a00*****",
      "IsDefault": true,
      "Status": "Associated"
    }
  ],
  "CaEnabled": false,
  "Certificates": [
    {
      "CertificateId": "123157*******"
    }
  ],
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "sgp-i5qt20******"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "ListenerDescription": "HTTP_80",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "ListenerPort": 80,
  "ListenerProtocol": "HTTP",
  "ListenerStatus": "Running",
  "LoadBalancerId": "alb-bd6oylbckp6k9x****",
  "LogConfig": {
    "AccessLogRecordCustomizedHeadersEnabled": true,
    "AccessLogTracingConfig": {
      "TracingEnabled": true,
      "TracingSample": 100,
      "TracingType": "Zipkin"
    }
  },
  "QuicConfig": {
    "QuicListenerId": "lsn-ek6ad66t****",
    "QuicUpgradeEnabled": true
  },
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "RequestTimeout": 34,
  "SecurityPolicyId": "tls_cipher_policy_1_1",
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ],
  "XForwardedForConfig": {
    "XForwardedForClientCertClientVerifyAlias": "test_client-verify-alias_123456",
    "XForwardedForClientCertClientVerifyEnabled": true,
    "XForwardedForClientCertFingerprintAlias": "test_finger-print-alias_123456",
    "XForwardedForClientCertFingerprintEnabled": true,
    "XForwardedForClientCertIssuerDNAlias": "test_issue-dn-alias_123456",
    "XForwardedForClientCertIssuerDNEnabled": true,
    "XForwardedForClientCertSubjectDNAlias": "test_subject-dn-alias_123456",
    "XForwardedForClientCertSubjectDNEnabled": true,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForHostEnabled": false,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Otentikasi operasi load balancing gagal.
404	ResourceNotFound.Listener	The specified resource %s is not found.	Pendengar tidak ada.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.