All Products
Search

This Product

    Global Accelerator:DescribeListener

    Document Center

    Global Accelerator:DescribeListener

    Last Updated:Sep 17, 2026

    Mengkueri konfigurasi pendengar tertentu.

    Deskripsi operasi

    Mengkueri konfigurasi pendengar tertentu, termasuk tipe perutean, status, stempel waktu pembuatan, dan informasi Port 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

    ga:DescribeListener

    get

    *Listener

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah instans Alibaba Cloud Akselerator Global (GA). Atur nilai menjadi cn-hangzhou.

    cn-hangzhou
    ListenerId

    string

    Yes

    ID pendengar yang akan dikueri.

    lsr-bp1bpn0kn908w4nbw****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    Description

    string

    Deskripsi pendengar.

    Listener
    RequestId

    string

    ID permintaan.

    6FEA0CF3-D3B9-43E5-A304-D217037876A8
    State

    string

    Status pendengar.

    • configuring: Pendengar sedang dikonfigurasi.

    • init: Pendengar sedang diinisialisasi.

    • updating: Pendengar sedang diperbarui.

    • deleting: Pendengar sedang dihapus.

    active
    CreateTime

    string

    Stempel waktu saat pendengar dibuat. Unit: milidetik.

    1577786252000
    PortRanges

    array<object>

    Informasi Port pendengar.

    object

    Informasi Port pendengar.

    FromPort

    integer

    Port pertama dalam range Port yang digunakan untuk menerima permintaan dan meneruskannya ke titik akhir.

    20
    ToPort

    integer

    Port terakhir dalam range Port yang digunakan untuk menerima permintaan dan meneruskannya ke titik akhir.

    20
    BackendPorts

    array<object>

    Informasi port backend.

    object

    Range port backend.

    FromPort

    string

    Port pertama dalam range Port yang digunakan oleh server backend untuk menerima permintaan.

    Parameter ini hanya dikembalikan ketika protokol pendengar adalah HTTPS dan Port pendengar sama dengan Port tempat layanan backend disediakan.

    80
    ToPort

    string

    Port terakhir dalam range port yang digunakan oleh server backend untuk menerima permintaan.

    80
    Certificates

    array<object>

    Daftar sertifikat SSL.

    object

    Daftar sertifikat SSL.

    Type

    string

    Tipe sertifikat.

    Saat ini, hanya Server (sertifikat server) yang didukung.

    Server
    Id

    string

    ID sertifikat SSL.

    449****-cn-hangzhou
    Protocol

    string

    Tipe protokol transmisi jaringan pendengar.

    • TCP: Protokol TCP.

    • UDP: Protokol UDP.

    • HTTP: Protokol HTTP.

    • HTTPS: Protokol HTTPS.

    TCP
    ListenerId

    string

    ID pendengar.

    lsr-bp1bpn0kn908w4nbw****
    ClientAffinity

    string

    Afinitas klien.

    • Jika NONE dikembalikan, afinitas klien tidak dipertahankan. Koneksi dari klien yang sama tidak selalu diarahkan ke titik akhir yang sama.

    • Jika SOURCE_IP dikembalikan, afinitas klien dipertahankan. Ketika klien mengakses aplikasi stateful, semua permintaan dari klien yang sama dapat diarahkan ke titik akhir yang sama, terlepas dari Port sumber dan protokol.

    SOURCE_IP
    Name

    string

    Nama pendengar.

    Listener
    RelatedAcls

    array<object>

    Informasi tentang kelompok kebijakan kontrol akses yang terkait dengan pendengar.

    object

    Informasi tentang kelompok kebijakan kontrol akses yang terkait dengan pendengar.

    AclId

    string

    ID kelompok kebijakan kontrol akses yang terkait dengan pendengar.

    123
    Status

    string

    Apakah fitur kontrol akses diaktifkan.

    • Associated: Diaktifkan.

    Associated
    AclType

    string

    Tipe kontrol akses:

    • white: Hanya permintaan dari alamat IP atau blok CIDR dalam kelompok kebijakan kontrol akses yang dipilih yang diteruskan. Daftar putih berlaku untuk skenario di mana aplikasi mengizinkan akses hanya dari alamat IP tertentu. Mengaktifkan daftar putih menimbulkan beberapa risiko. Setelah daftar putih diaktifkan, hanya alamat IP dalam daftar putih yang dapat mengakses pendengar Akselerator Global. Jika daftar putih diaktifkan tetapi tidak ada alamat IP yang ditambahkan ke kelompok kebijakan kontrol akses, pendengar Akselerator Global tidak meneruskan permintaan apa pun.

    • black: Semua permintaan dari alamat IP atau blok CIDR dalam kelompok kebijakan kontrol akses yang dipilih diblokir. Blacklist berlaku untuk skenario di mana aplikasi menolak akses hanya dari alamat IP tertentu. Jika blacklist diaktifkan tetapi tidak ada alamat IP yang ditambahkan ke kelompok kebijakan kontrol akses, pendengar Akselerator Global meneruskan semua permintaan.

    Parameter ini hanya dikembalikan ketika nilai parameter Status adalah on.

    white
    AcceleratorId

    string

    ID instans Alibaba Cloud Akselerator Global (GA).

    ga-bp1odcab8tmno0hdq****
    ProxyProtocol deprecated

    boolean

    Apakah fitur pelestarian alamat IP klien diaktifkan.

    • true: Fitur pelestarian alamat IP klien diaktifkan. Setelah fitur ini diaktifkan, layanan backend dapat melihat alamat IP asal klien.

    • false: Fitur pelestarian alamat IP klien dinonaktifkan.

    false
    XForwardedForConfig

    object

    Informasi konfigurasi bidang XForward.

    XForwardedForGaIdEnabled

    boolean

    Apakah header GA-ID digunakan untuk mengambil ID instans Alibaba Cloud Akselerator Global (GA).

    • true: Ya.

    • false: Tidak.

    Catatan

    Hanya pendengar HTTP dan HTTPS yang mendukung parameter ini.

    false
    XForwardedForGaApEnabled

    boolean

    Apakah header GA-AP digunakan untuk mengambil informasi area percepatan.

    • true: Ya.

    • false: Tidak.

    Catatan

    Hanya pendengar HTTP dan HTTPS yang mendukung parameter ini.

    false
    XForwardedForProtoEnabled

    boolean

    Apakah header GA-X-Forward-Proto digunakan untuk mengambil protokol pendengar instans Alibaba Cloud Akselerator Global (GA).

    • true: Ya.

    • false: Tidak.

    Catatan

    Hanya pendengar HTTP dan HTTPS yang mendukung parameter ini.

    false
    XForwardedForPortEnabled

    boolean

    Apakah header GA-X-Forward-Port digunakan untuk mengambil Port pendengar instans Alibaba Cloud Akselerator Global (GA).

    • true: Ya.

    • false: Tidak.

    Catatan

    Hanya pendengar HTTP dan HTTPS yang mendukung parameter ini.

    false
    XRealIpEnabled

    boolean

    Apakah header X-Real-IP digunakan untuk mengambil alamat IP klien sebenarnya.

    • true: Ya.

    • false: Tidak.

    Catatan

    Hanya pendengar HTTP dan HTTPS yang mendukung parameter ini.

    false
    SecurityPolicyId

    string

    ID instans kebijakan keamanan TLS.

    • tls_cipher_policy_1_0

      • Versi TLS yang didukung: TLSv1.0, TLSv1.1, dan TLSv1.2.

      • Suite algoritma enkripsi 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: TLSv1.1 dan TLSv1.2.

      • Suite algoritma enkripsi 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: TLSv1.2.

      • Suite algoritma enkripsi 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: TLSv1.2.

      • Suite algoritma enkripsi 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: TLSv1.2 dan TLSv1.3.

      • Suite algoritma enkripsi 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

    Hanya pendengar HTTPS yang mendukung parameter ini.

    tls_cipher_policy_1_0
    Type

    string

    Tipe perutean pendengar.

    • Standard: Jenis Penyimpanan Standar.

    • CustomRouting: Tipe perutean kustom.

    Standard
    ServiceId

    string

    ID layanan yang mengelola instans terkelola.

    Catatan

    Parameter ini hanya valid ketika parameter ServiceManaged diatur ke True.

    ALB
    ServiceManaged

    boolean

    Apakah instans dikelola. Nilai valid:

    • true: Instans dikelola.

    • false: Instans tidak dikelola.

    true
    ServiceManagedInfos

    array<object>

    Daftar kebijakan aksi yang dapat dieksekusi pengguna pada instans terkelola.

    Catatan

    • Parameter ini hanya valid ketika parameter ServiceManaged diatur ke True.

    • Ketika instans berada dalam status terkelola, operasi pengguna pada instans dibatasi, dan operasi tertentu dilarang.

    object

    Daftar kebijakan aksi yang dapat dieksekusi pengguna pada instans terkelola.

    Action

    string

    Nama aksi kebijakan terkelola. Nilai valid:

    • Create: Membuat instans.

    • Update: Memperbarui instans saat ini.

    • Delete: Menghapus instans saat ini.

    • Associate: Mereferensikan atau direferensikan oleh instans saat ini.

    • UserUnmanaged: Membatalkan pengelolaan instans.

    • CreateChild: Membuat Sumber daya turunan di bawah instans saat ini.

    Update
    ChildType

    string

    Tipe Sumber daya turunan. Nilai valid:

    • Listener: Sumber daya pendengar.

    • IpSet: Sumber daya wilayah akselerasi.

    • EndpointGroup: Sumber daya kelompok titik akhir.

    • ForwardingRule: Sumber daya aturan pengalihan.

    • Endpoint: Sumber daya titik akhir.

    • EndpointGroupDestination: Sumber daya pemetaan protokol kelompok titik akhir di bawah pendengar perutean kustom.

    • EndpointPolicy: Sumber daya kebijakan trafik titik akhir di bawah pendengar perutean kustom.

    Catatan

    Parameter ini hanya valid ketika parameter Action diatur ke CreateChild.

    Listener
    IsManaged

    boolean

    Apakah aksi kebijakan terkelola dikelola. Nilai valid:

    • true: Aksi kebijakan terkelola dikelola. Pengguna tidak dapat melakukan operasi yang ditentukan oleh Action pada instans terkelola.

    • false: Aksi kebijakan terkelola tidak dikelola. Pengguna dapat melakukan operasi yang ditentukan oleh Action pada instans terkelola.

    false
    IdleTimeout

    integer

    Periode waktu tunggu koneksi tidak aktif. Unit: detik.

    900
    RequestTimeout

    integer

    Periode waktu tunggu permintaan koneksi HTTP/HTTPS. Unit: detik.

    Catatan

    Parameter ini hanya valid untuk pendengar yang Protocol (tipe protokol transmisi jaringan)-nya adalah HTTP atau HTTPS. Jika server backend tidak mengembalikan tanggapan dalam periode waktu tunggu, Akselerator Global berhenti menunggu dan mengembalikan kode kesalahan HTTP 504 ke klien.

    60
    HttpVersion

    string

    Versi maksimum protokol HTTP. Nilai valid:

    • http3: HTTP/3.

    • http2: HTTP/2.

    • http1.1: HTTP/1.1.

    Catatan

    Hanya pendengar HTTPS yang mendukung parameter ini.

    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.