DescribeListener - Global Accelerator

Menjelaskan konfigurasi listener tertentu.

Deskripsi operasi

Operasi ini melakukan kueri terhadap konfigurasi listener yang ditentukan, termasuk tipe routing, status, timestamp pembuatan, dan informasi port.

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

ga:DescribeListener

get

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah tempat instans Alibaba Cloud Global Accelerator (GA) dideploy. Tetapkan nilainya ke cn-hangzhou.	cn-hangzhou
ListenerId	string	Yes	ID listener yang ingin Anda kueri.	lsr-bp1bpn0kn908w4nbw****

Elemen respons

Element	Type	Description	Example
	object	Informasi yang dikembalikan.
Description	string	Deskripsi listener.	Listener
RequestId	string	ID permintaan.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	Status listener. configuring: Listener sedang dikonfigurasi. init: Listener sedang diinisialisasi. updating: Listener sedang diperbarui. deleting: Listener sedang dihapus.	active
CreateTime	string	Timestamp yang menunjukkan kapan listener dibuat. Satuan: milidetik.	1577786252000
PortRanges	array<object>	Informasi port listener.
	object	Informasi port listener.
FromPort	integer	Awal dari rentang port listener yang digunakan untuk menerima dan meneruskan permintaan ke titik akhir.	20
ToPort	integer	Akhir dari rentang port listener yang digunakan untuk menerima dan meneruskan permintaan ke titik akhir.	20
BackendPorts	array<object>	Informasi port backend.
	object	Rentang port backend.
FromPort	string	Port awal server backend yang digunakan untuk menerima permintaan. Parameter ini hanya dikembalikan ketika protokol listener adalah HTTPS dan port listener sama dengan port layanan server backend.	80
ToPort	string	Port akhir server backend yang digunakan untuk menerima permintaan.	80
Certificates	array<object>	Daftar sertifikat SSL.
	object	Daftar sertifikat SSL.
Type	string	Tipe sertifikat. Hanya Server yang dikembalikan, yang menunjukkan sertifikat sisi server.	Server
Id	string	ID sertifikat SSL.	449****-cn-hangzhou
Protocol	string	Protokol transport jaringan yang digunakan oleh listener. TCP: TCP. UDP: UDP. HTTP: HTTP. HTTPS: HTTPS.	TCP
ListenerId	string	ID listener.	lsr-bp1bpn0kn908w4nbw****
ClientAffinity	string	Afinitas klien. Jika NONE dikembalikan, afinitas klien dinonaktifkan. Dalam hal ini, permintaan dari klien yang sama dapat diteruskan ke titik akhir yang berbeda. Jika SOURCE_IP dikembalikan, afinitas klien diaktifkan. Saat klien mengakses aplikasi berstatus, semua permintaan dari klien yang sama akan diteruskan ke titik akhir yang sama terlepas dari port sumber atau protokolnya.	SOURCE_IP
Name	string	Nama listener.	Listener
RelatedAcls	array<object>	Kelompok kebijakan kontrol akses yang terkait dengan listener.
	object	Kelompok kebijakan kontrol akses yang terkait dengan listener.
AclId	string	ID daftar kontrol akses (ACL) yang terkait dengan listener.	123
Status	string	Menunjukkan apakah fitur kontrol akses diaktifkan. Associated: Fitur kontrol akses diaktifkan.	Associated
AclType	string	Tipe ACL. white: daftar putih. Hanya permintaan dari alamat IP atau blok CIDR dalam ACL yang diteruskan. Daftar putih cocok untuk aplikasi yang hanya mengizinkan akses dari alamat IP tertentu. Jika Anda mengaktifkan daftar putih tetapi tidak menambahkan alamat IP ke ACL, listener GA tidak akan meneruskan permintaan. black: blacklist. Semua permintaan dari alamat IP atau blok CIDR dalam ACL ditolak. Blacklist cocok untuk aplikasi yang menolak akses dari alamat IP tertentu. Jika Anda mengaktifkan blacklist tetapi tidak menambahkan alamat IP ke ACL, listener GA akan meneruskan semua permintaan. Parameter ini dikembalikan saat ACL dikaitkan dengan listener.	white
AcceleratorId	string	ID instans GA.	ga-bp1odcab8tmno0hdq****
ProxyProtocol `deprecated`	boolean	Menunjukkan apakah protokol proxy digunakan untuk mempertahankan alamat IP klien. true: Protokol proxy digunakan untuk mempertahankan alamat IP klien. Setelah fitur ini diaktifkan, Anda dapat melihat alamat IP asli klien pada layanan backend. false: Protokol proxy tidak digunakan untuk mempertahankan alamat IP klien.	false
XForwardedForConfig	object	Konfigurasi header `X-Forwarded-For`.
XForwardedForGaIdEnabled	boolean	Menunjukkan apakah header `GA-ID` digunakan untuk mengambil ID instans GA. true: ya. false: tidak. Catatan Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	false
XForwardedForGaApEnabled	boolean	Menunjukkan apakah header `GA-AP` digunakan untuk mengambil informasi tentang wilayah akselerasi. true: ya. false: tidak. Catatan Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	false
XForwardedForProtoEnabled	boolean	Menunjukkan apakah header `GA-X-Forward-Proto` digunakan untuk mengambil protokol listener instans GA. true: ya. false: tidak. Catatan Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	false
XForwardedForPortEnabled	boolean	Menunjukkan apakah header `GA-X-Forward-Port` digunakan untuk mengambil port listener instans GA. true: ya. false: tidak. Catatan Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	false
XRealIpEnabled	boolean	Menunjukkan apakah header `X-Real-IP` digunakan untuk mengambil alamat IP asli klien. true: ya. false: tidak. Catatan Parameter ini hanya tersedia untuk listener HTTP dan HTTPS.	false
SecurityPolicyId	string	ID kebijakan keamanan. tls_cipher_policy_1_0 Versi TLS yang didukung: TLS 1.0, TLS 1.1, dan TLS 1.2. Paket sandi yang didukung: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, dan DES-CBC3-SHA. tls_cipher_policy_1_1 Versi TLS yang didukung: TLS 1.1 dan TLS 1.2. Paket sandi yang didukung: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, dan DES-CBC3-SHA. tls_cipher_policy_1_2 Versi TLS yang didukung: TLS 1.2. Paket sandi yang didukung: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, dan DES-CBC3-SHA. tls_cipher_policy_1_2_strict Versi TLS yang didukung: TLS 1.2. Paket sandi yang didukung: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, dan ECDHE-RSA-AES256-SHA. tls_cipher_policy_1_2_strict_with_1_3 Versi TLS yang didukung: TLS 1.2 dan TLS 1.3. Paket sandi yang didukung: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, dan ECDHE-RSA-AES256-SHA. Catatan Parameter ini hanya tersedia untuk listener HTTPS.	tls_cipher_policy_1_0
Type	string	Tipe routing listener. Standard: routing cerdas. CustomRouting: routing kustom.	Standard
ServiceId	string	ID layanan yang mengelola instans. Catatan Parameter ini hanya dikembalikan ketika ServiceManaged diatur ke True.	ALB
ServiceManaged	boolean	Menunjukkan apakah instans tersebut merupakan instans terkelola. Nilai yang valid: true: Instans tersebut merupakan instans terkelola. false: Instans tersebut bukan instans terkelola.	true
ServiceManagedInfos	array<object>	Aksi yang dapat Anda lakukan pada instans terkelola. Catatan Parameter ini hanya dikembalikan ketika ServiceManaged diatur ke True. Ketika instans berada dalam status terkelola, Anda tidak dapat melakukan beberapa operasi pada instans tersebut.
	object	Aksi yang dapat Anda lakukan pada instans terkelola.
Action	string	Nama aksi pada instans terkelola. Nilai yang valid: Create: Membuat instans. Update: Memperbarui instans saat ini. Delete: Menghapus instans saat ini. Associate: Mengaitkan instans dengan resource lain. UserUnmanaged: Menghentikan pengelolaan instans. CreateChild: Membuat resource anak dalam instans.	Update
ChildType	string	Tipe resource anak. Nilai yang valid: Listener: listener. IpSet: wilayah akselerasi. EndpointGroup: kelompok titik akhir. ForwardingRule: aturan pengalihan. Endpoint: titik akhir. EndpointGroupDestination: pemetaan protokol kelompok titik akhir yang terkait dengan listener routing kustom. EndpointPolicy: kebijakan traffic titik akhir yang terkait dengan listener routing kustom. Catatan Parameter ini hanya dikembalikan ketika Action diatur ke CreateChild.	Listener
IsManaged	boolean	Menunjukkan apakah aksi yang ditentukan dikelola. Nilai yang valid: true: Aksi yang ditentukan dikelola. Anda tidak dapat melakukan aksi tersebut pada instans terkelola. false: Aksi yang ditentukan tidak dikelola. Anda dapat melakukan aksi tersebut pada instans terkelola.	false
IdleTimeout	integer	Periode timeout untuk koneksi idle. Satuan: detik.	900
RequestTimeout	integer	Periode timeout untuk permintaan HTTP atau HTTPS. Satuan: detik. Catatan Parameter ini hanya tersedia untuk listener HTTP dan HTTPS. Jika server backend tidak merespons dalam periode timeout, GA akan mengembalikan error HTTP 504 ke klien.	60
HttpVersion	string	Versi maksimum protokol HTTP. Nilai yang valid: http3: HTTP/3. http2: HTTP/2. http1.1: HTTP/1.1. Catatan Parameter ini hanya tersedia untuk listener HTTPS.	http2

Contoh

Respons sukses

JSONformat

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "TCP",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "Associated"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": false
  },
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "Type": "Standard",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "IdleTimeout": 900,
  "RequestTimeout": 60,
  "HttpVersion": "http2"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	NotExist.Listener	listener %s is not exist
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.