GetListenerAttribute - Server Load Balancer

Mengambil detail listener.

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 listener.	lsr-bp1bpn0kn908w4nbw****

Elemen respons

Element	Type	Description	Example
	object	Detail mengenai listener tersebut.
AclConfig	object	Konfigurasi daftar kontrol akses (ACL).
AclRelations	array<object>	ID ACL yang terkait dengan listener.
	object	Struktur ACL yang terkait dengan listener.
AclId	string	ID ACL yang terkait dengan listener.	acl-doc****
Status	string	Menunjukkan apakah ACL telah dikaitkan dengan listener. Nilai yang valid: Associating Associated Dissociating	Associating
AclType	string	Jenis ACL. Nilai yang valid: White: daftar putih. Hanya permintaan dari alamat IP atau blok CIDR dalam ACL jaringan yang diteruskan. Daftar putih cocok untuk skenario di mana Anda hanya ingin mengizinkan alamat IP tertentu mengakses aplikasi. Layanan Anda mungkin terganggu jika daftar putih tidak dikonfigurasi dengan benar. Jika daftar putih dikonfigurasi untuk listener, hanya permintaan dari alamat IP yang ada dalam daftar putih yang akan diteruskan oleh listener tersebut. Jika Anda mengaktifkan daftar putih tetapi tidak menambahkan alamat IP ke dalamnya, listener akan meneruskan semua permintaan. Black: blacklist. Permintaan dari alamat IP atau blok CIDR dalam ACL jaringan ditolak. Blacklist cocok untuk skenario di mana Anda ingin menolak akses dari alamat IP atau blok CIDR tertentu ke aplikasi. Jika blacklist dikonfigurasi untuk listener tetapi tidak ada alamat IP yang ditambahkan ke dalamnya, listener akan meneruskan semua permintaan.	White
Certificates	array<object>	Daftar sertifikat.
	object	Konfigurasi sertifikat.
CertificateId	string	ID sertifikat. Hanya sertifikat server yang didukung.	12315790212_166f8204689_1714763408_70998****
CaCertificates	array<object>	Daftar sertifikat CA default.
	object
CertificateId	string	ID sertifikat CA default.	139a00604bd-cn-east-hangzho****
Status	string	Status sertifikat.	Associated
IsDefault	boolean	Menunjukkan apakah sertifikat tersebut merupakan sertifikat default. Nilai yang valid: true false	true
CaEnabled	boolean	Menunjukkan apakah otentikasi timbal balik diaktifkan. Nilai yang valid: true false	false
DefaultActions	array<object>	Aksi aturan pengalihan default.
	array<object>	Konfigurasi aturan pengalihan default.
ForwardGroupConfig	object	Konfigurasi aksi ForwardGroup. Parameter ini dikembalikan dan berlaku ketika Type diatur ke ForwardGroup.
ServerGroupTuples	array<object>	Kelompok server tempat permintaan diteruskan.
	object	Kelompok server tempat permintaan diteruskan.
ServerGroupId	string	ID kelompok server tempat permintaan diteruskan.	rsp-cige6j****
Type	string	Jenis aksi. Jika ForwardGroup dikembalikan, permintaan diteruskan ke beberapa kelompok vServer.	ForwardGroup
GzipEnabled	boolean	Menunjukkan apakah kompresi GZIP diaktifkan untuk mengompres jenis file tertentu. Nilai yang valid: true false	true
Http2Enabled	boolean	Menunjukkan apakah HTTP/2 diaktifkan. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	true
IdleTimeout	integer	Periode timeout koneksi idle. Satuan: detik. Jika tidak ada permintaan yang diterima dalam periode timeout yang ditentukan, Application Load Balancer (ALB) akan menutup koneksi saat ini. Saat permintaan diterima, ALB akan membuat koneksi baru.	2
ListenerDescription	string	Nama listener.	test
ListenerId	string	ID listener.	lsr-bp1bpn0kn908w4nbw****
ListenerPort	integer	Port antarmuka depan yang digunakan oleh instans ALB.	80
ListenerProtocol	string	Protokol listener. Nilai yang valid: HTTP, HTTPS, dan QUIC.	HTTP
ListenerStatus	string	Status listener. Nilai yang valid: Provisioning Running Configuring Stopped	Running
LoadBalancerId	string	ID instans ALB.	lb-bp1o94dp5i6ea****
LogConfig	object	Konfigurasi logging.
AccessLogRecordCustomizedHeadersEnabled	boolean	Menunjukkan apakah header kustom dicatat dalam log akses. Nilai yang valid: true false	true
AccessLogTracingConfig	object	Konfigurasi Xtrace. Xtrace digunakan untuk mencatat permintaan yang dikirim ke ALB.
TracingEnabled	boolean	Menunjukkan apakah Xtrace diaktifkan. Nilai yang valid: true false Catatan Anda hanya dapat mengatur parameter ini ke true jika parameter AccessLogEnabled diatur ke true.	true
TracingSample	integer	Laju pengambilan sampel Xtrace. Nilai yang valid: 1 hingga 10000. Catatan Jika TracingEnabled diatur ke true, parameter ini berlaku.	100
TracingType	string	Jenis Xtrace. Jenis Xtrace yang didukung: Zipkin. Catatan Jika TracingEnabled diatur ke true, parameter ini berlaku.	Zipkin
QuicConfig	object	Informasi konfigurasi saat listener dikaitkan dengan listener QUIC.
QuicListenerId	string	ID listener QUIC. Parameter ini dikembalikan ketika QuicUpgradeEnabled diatur ke true. Hanya listener HTTPS yang mendukung parameter ini. Catatan Anda harus mengaitkan listener HTTPS dan listener QUIC dengan instans ALB yang sama. Selain itu, pastikan bahwa listener QUIC belum pernah dikaitkan dengan listener lain.	lsn-333
QuicUpgradeEnabled	boolean	Menunjukkan apakah peningkatan QUIC diaktifkan. Nilai yang valid: true false Catatan Hanya listener HTTPS yang mendukung parameter ini.	true
RequestId	string	ID permintaan.	365F4154-92F6-4AE4-92F8-7FF34B540710
RequestTimeout	integer	Periode timeout permintaan. Satuan: detik. Jika tidak ada tanggapan yang diterima dari server backend dalam periode timeout yang ditentukan, ALB akan mengembalikan kode kesalahan `HTTP 504` kepada klien.	34
SecurityPolicyId	string	Kebijakan keamanan. Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	tls_cipher_policy_1_1
XForwardedForConfig	object	Konfigurasi header XForward.
XForwardedForClientCertClientVerifyAlias	string	Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertClientVerifyEnabled diatur ke true. Nama terdiri dari 1 hingga 40 karakter, dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Clientcert-clientverify` digunakan untuk mengambil hasil verifikasi sertifikat klien. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	true
XForwardedForClientCertFingerprintAlias	string	Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertFingerprintEnabled diatur ke true. Nama terdiri dari 1 hingga 40 karakter, dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Clientcert-fingerprint` digunakan untuk mengambil sidik jari sertifikat klien. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	true
XForwardedForClientCertIssuerDNAlias	string	Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertIssuerDNEnabled diatur ke true. Nama terdiri dari 1 hingga 40 karakter, dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Clientcert-issuerdn` digunakan untuk mengambil informasi tentang otoritas penerbit sertifikat klien. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	true
XForwardedForClientCertSubjectDNAlias	string	Nama header kustom. Parameter ini berlaku hanya ketika XForwardedForClientCertSubjectDNEnabled diatur ke true. Nama terdiri dari 1 hingga 40 karakter, dan dapat berisi huruf kecil, tanda hubung (-), garis bawah (_), dan angka. Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Clientcert-subjectdn` digunakan untuk mengambil informasi tentang pemilik sertifikat klien. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTPS.	true
XForwardedForClientSrcPortEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Client-Port` digunakan untuk mengambil port klien. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTP atau HTTPS.	true
XForwardedForEnabled	boolean	Menunjukkan apakah header `X-Forwarded-For` digunakan untuk mengambil alamat IP klien. Nilai yang valid: true (default) false Catatan Jika parameter ini diatur ke true, nilai default parameter XForwardedForProcessingMode adalah append. Anda dapat mengubahnya menjadi remove. Jika parameter ini diatur ke false, header `X-Forwarded-For` dalam permintaan tidak dimodifikasi sebelum permintaan dikirim ke server backend. Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	true
XForwardedForProcessingMode	string	Menentukan cara header `X-Forwarded-For` diproses. Parameter ini berlaku hanya ketika XForwardedForEnabled diatur ke true. Nilai yang valid: append (default) remove Catatan Jika parameter ini diatur ke append, ALB menambahkan alamat IP hop terakhir ke header `X-Forwarded-For` yang sudah ada dalam permintaan sebelum permintaan dikirim ke server backend. Jika parameter ini diatur ke remove, ALB menghapus header `X-Forwarded-For` dalam permintaan sebelum permintaan dikirim ke server backend, terlepas dari apakah permintaan membawa header `X-Forwarded-For` atau tidak. Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	append
XForwardedForProtoEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Proto` digunakan untuk mengambil protokol pendengaran. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTP, HTTPS, atau QUIC.	true
XForwardedForSLBIdEnabled	boolean	Menunjukkan apakah header `SLB-ID` digunakan untuk mengambil ID instans CLB. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTP, HTTPS, atau QUIC.	true
XForwardedForSLBPortEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Port` digunakan untuk mengambil port pendengaran instans ALB. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTP, HTTPS, atau QUIC.	true
XForwardedForClientSourceIpsEnabled	boolean	Menunjukkan apakah header `X-Forwarded-Client-Ip` digunakan untuk mengambil port sumber instans ALB. Nilai yang valid: true false Catatan Parameter ini hanya tersedia saat Anda membuat listener HTTP, HTTPS, atau QUIC.	false
XForwardedForClientSourceIpsTrusted	string	Alamat IP proksi tepercaya. ALB melintasi `X-Forwarded-For` secara mundur dan memilih alamat IP pertama yang tidak ada dalam daftar alamat IP tepercaya sebagai alamat IP asli klien. Alamat IP ini digunakan dalam pembatasan kecepatan berdasarkan alamat IP sumber.	10.1.1.0/24
XForwardedForHostEnabled	boolean	Menentukan apakah header `X-Forwarded-Host` digunakan untuk mengambil nama domain klien. Nilai yang valid: true false (default) Catatan Parameter ini tersedia untuk listener HTTP, HTTPS, dan QUIC.	false
Tags	array<object>	Tag.
	object	Tag.
Key	string	Kunci tag. Panjang kunci tag maksimal 128 karakter dan tidak boleh diawali dengan `acs:` atau `aliyun`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	env
Value	string	Nilai tag. Panjang nilai tag maksimal 128 karakter dan tidak boleh diawali dengan `acs:` atau `aliyun`. Nilai tag tidak boleh mengandung `http://` atau `https://`.	product

Contoh

Respons sukses

JSONformat

{
  "AclConfig": {
    "AclRelations": [
      {
        "AclId": "acl-doc****",
        "Status": "Associating"
      }
    ],
    "AclType": "White"
  },
  "Certificates": [
    {
      "CertificateId": "12315790212_166f8204689_1714763408_70998****"
    }
  ],
  "CaCertificates": [
    {
      "CertificateId": "139a00604bd-cn-east-hangzho****",
      "Status": "Associated",
      "IsDefault": true
    }
  ],
  "CaEnabled": false,
  "DefaultActions": [
    {
      "ForwardGroupConfig": {
        "ServerGroupTuples": [
          {
            "ServerGroupId": "rsp-cige6j****"
          }
        ]
      },
      "Type": "ForwardGroup"
    }
  ],
  "GzipEnabled": true,
  "Http2Enabled": true,
  "IdleTimeout": 2,
  "ListenerDescription": "test",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ListenerPort": 80,
  "ListenerProtocol": "HTTP",
  "ListenerStatus": "Running",
  "LoadBalancerId": "lb-bp1o94dp5i6ea****",
  "LogConfig": {
    "AccessLogRecordCustomizedHeadersEnabled": true,
    "AccessLogTracingConfig": {
      "TracingEnabled": true,
      "TracingSample": 100,
      "TracingType": "Zipkin"
    }
  },
  "QuicConfig": {
    "QuicListenerId": "lsn-333",
    "QuicUpgradeEnabled": true
  },
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "RequestTimeout": 34,
  "SecurityPolicyId": "tls_cipher_policy_1_1",
  "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,
    "XForwardedForClientSrcPortEnabled": true,
    "XForwardedForEnabled": true,
    "XForwardedForProcessingMode": "append",
    "XForwardedForProtoEnabled": true,
    "XForwardedForSLBIdEnabled": true,
    "XForwardedForSLBPortEnabled": true,
    "XForwardedForClientSourceIpsEnabled": false,
    "XForwardedForClientSourceIpsTrusted": "10.1.1.0/24",
    "XForwardedForHostEnabled": false
  },
  "Tags": [
    {
      "Key": "env",
      "Value": "product"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.Listener	The specified resource %s is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.