全部产品
Search

搜索本产品

    Global Accelerator：DescribeListener

    文档中心

    Global Accelerator：DescribeListener

    更新时间：Dec 14, 2025

    Mengambil informasi konfigurasi listener dari instans Global Accelerator (GA).

    Deskripsi operasi

    Operasi ini digunakan untuk mengambil informasi konfigurasi listener dari instans GA, mencakup tipe routing listener, status listener, stempel waktu pembuatan listener, dan port 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

    ga:DescribeListener

    get

    *Listener

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah tempat instans GA ditempatkan. Tetapkan nilainya ke cn-hangzhou.

    cn-hangzhou
    ListenerId

    string

    Yes

    ID listener yang ingin Anda tanyakan.

    lsr-bp1bpn0kn908w4nbw****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    Description

    string

    Deskripsi listener.

    Listener
    RequestId

    string

    ID permintaan.

    6FEA0CF3-D3B9-43E5-A304-D217037876A8

    State

    string

    Status listener. Nilai yang valid:

    • configuring: Listener sedang dikonfigurasi.

    • init: Listener sedang diinisialisasi.

    • updating: Listener sedang diperbarui.

    • deleting: Listener sedang dihapus.

    active
    CreateTime

    string

    Waktu saat listener dibuat. Nilai ini merupakan Stempel waktu UNIX yang merepresentasikan jumlah milidetik sejak 1 Januari 1970 pukul 00:00:00 UTC. Satuan: milidetik.

    1577786252000
    PortRanges

    array<object>

    Informasi mengenai port listener.

    object

    Detail mengenai port listener.

    FromPort

    integer

    Port pertama dalam rentang port listener yang digunakan untuk menerima dan meneruskan permintaan ke titik akhir.

    20
    ToPort

    integer

    Port terakhir dalam rentang port listener yang digunakan untuk menerima dan meneruskan permintaan ke titik akhir.

    20
    BackendPorts

    array<object>

    Informasi mengenai port backend.

    object

    Detail mengenai port backend.

    FromPort

    string

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

    Parameter ini hanya dikembalikan jika listener HTTPS dikonfigurasi dan port listener sama dengan port layanan server backend.

    80
    ToPort

    string

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

    80
    Certificates

    array<object>

    Sertifikat SSL.

    object

    Sertifikat SSL.

    Type

    string

    Tipe Sertifikat SSL.

    Hanya Server yang dapat dikembalikan, yang menunjukkan Sertifikat server.

    Server
    Id

    string

    ID Sertifikat SSL.

    449****-cn-hangzhou
    Protocol

    string

    Protokol transmisi jaringan yang digunakan oleh listener. Nilai yang valid:

    • tcp: TCP.

    • udp: UDP.

    • http: HTTP.

    • https: HTTPS.

    tcp
    ListenerId

    string

    ID listener.

    lsr-bp1bpn0kn908w4nbw****
    ClientAffinity

    string

    Menunjukkan apakah afinitas klien diaktifkan untuk listener.

    • Jika NONE dikembalikan, afinitas klien dinonaktifkan. Permintaan dari klien yang sama dapat diteruskan ke titik akhir yang berbeda.

    • Jika SOURCE_IP dikembalikan, afinitas klien diaktifkan. Saat klien mengakses aplikasi berstatus, 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>

    Informasi mengenai daftar kontrol akses (ACL) yang terkait dengan listener.

    object

    AclId

    string

    ID ACL yang terkait dengan listener.

    123
    Status

    string

    Menunjukkan apakah fitur kontrol akses diaktifkan. Nilai yang valid:

    • on: diaktifkan.

    • off: dinonaktifkan.

    off
    AclType

    string

    Tipe ACL. Nilai yang valid:

    • white: daftar putih. Hanya permintaan dari alamat IP atau Blok CIDR dalam ACL yang diteruskan. Daftar putih cocok untuk skenario di mana Anda hanya ingin mengizinkan alamat IP tertentu mengakses aplikasi. Jika daftar putih dikonfigurasi secara tidak tepat, risiko dapat muncul. Setelah daftar putih dikonfigurasi untuk listener, hanya permintaan dari alamat IP yang ditambahkan ke daftar putih yang didistribusikan oleh listener. Jika daftar putih diaktifkan tetapi tidak ada alamat IP yang ditambahkan ke ACL, listener tidak akan meneruskan permintaan apa pun.

    • black: blacklist. Semua permintaan dari alamat IP atau Blok CIDR dalam ACL diblokir. Blacklist cocok untuk skenario di mana Anda ingin menolak akses dari alamat IP tertentu ke aplikasi. Jika blacklist diaktifkan tetapi tidak ada alamat IP yang ditambahkan ke ACL, listener akan meneruskan semua permintaan.

    Parameter ini hanya dikembalikan jika nilai Status adalah on.

    white
    AcceleratorId

    string

    ID instans GA.

    ga-bp1odcab8tmno0hdq****
    ProxyProtocol deprecated

    boolean

    Menunjukkan apakah fitur pelestarian alamat IP klien diaktifkan. Nilai yang valid:

    • true Anda dapat melihat alamat IP sumber klien melalui layanan backend.

    • false

    false
    XForwardedForConfig

    object

    Konfigurasi header XForward.

    XForwardedForGaIdEnabled

    boolean

    Menunjukkan apakah header GA-ID digunakan untuk mengambil ID instans GA. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya dikembalikan untuk listener HTTP dan HTTPS.

    false
    XForwardedForGaApEnabled

    boolean

    Menunjukkan apakah header GA-AP digunakan untuk mengambil informasi mengenai wilayah akselerasi. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya dikembalikan untuk listener HTTP dan HTTPS.

    false
    XForwardedForProtoEnabled

    boolean

    Menunjukkan apakah header GA-X-Forward-Proto digunakan untuk mengambil protokol listener instans GA. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya dikembalikan untuk listener HTTP dan HTTPS.

    false
    XForwardedForPortEnabled

    boolean

    Menunjukkan apakah header GA-X-Forward-Port digunakan untuk mengambil port listener instans GA. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya dikembalikan untuk listener HTTP dan HTTPS.

    false
    XRealIpEnabled

    boolean

    Menunjukkan apakah header X-Real-IP digunakan untuk mengambil alamat IP klien. Nilai yang valid:

    • true

    • false

    Catatan

    Parameter ini hanya dikembalikan untuk listener HTTP dan HTTPS.

    false
    SecurityPolicyId

    string

    ID kebijakan keamanan.

    • tls_cipher_policy_1_0

      • Versi Transport Layer Security (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 dikembalikan untuk listener HTTPS.

    tls_cipher_policy_1_0
    Type

    string

    Tipe routing listener. Nilai yang valid:

    • Standard: routing cerdas.

    • CustomRouting: routing kustom.

    Standard
    ServiceId

    string

    ID layanan yang mengelola instans.

    Catatan

    Parameter ini hanya dikembalikan jika nilai ServiceManaged adalah true.

    ALB
    ServiceManaged

    boolean

    Menunjukkan apakah instans dikelola. Nilai yang valid:

    • true

    • false

    true
    ServiceManagedInfos

    array<object>

    Aksi yang dapat dilakukan pengguna pada instans terkelola.

    Catatan

    • Parameter ini hanya dikembalikan jika nilai ServiceManaged adalah true.

    • Pengguna hanya dapat melakukan aksi tertentu pada instans terkelola.

    object

    Daftar kebijakan aksi yang dapat dieksekusi pengguna pada instans terkelola ini.

    Action

    string

    Nama aksi pada instans terkelola. Nilai yang valid:

    • Create

    • Update

    • Delete

    • Associate

    • UserUnmanaged

    • CreateChild

    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 trafik titik akhir yang terkait dengan listener routing kustom.

    Catatan

    Parameter ini hanya dikembalikan jika nilai Action adalah CreateChild.

    Listener
    IsManaged

    boolean

    Menunjukkan apakah aksi yang ditentukan dikelola.

    • true: Aksi yang ditentukan dikelola, dan pengguna tidak dapat melakukan aksi tersebut pada instans terkelola.

    • false: Aksi yang ditentukan tidak dikelola, dan pengguna dapat melakukan aksi tersebut pada instans terkelola.

    false
    IdleTimeout

    integer

    Periode timeout koneksi idle. Satuan: detik.

    900
    RequestTimeout

    integer

    Periode timeout permintaan HTTP atau HTTPS. Satuan: detik.

    Catatan

    Parameter ini hanya dikembalikan untuk listener HTTP dan HTTPS. Jika tidak ada respons yang diterima dari server backend dalam periode timeout yang ditentukan, GA akan mengembalikan kode kesalahan HTTP 504 ke klien.

    60
    HttpVersion

    string

    Versi maksimum protokol HTTP. Nilai yang valid:

    • http3

    • http2

    • http1.1

    Catatan

    Parameter ini hanya dikembalikan 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": "off"
    }
  ],
  "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 The listener %s does not exist.
    500 UnknownError An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. An error occurred while the request was being processed. Try again later.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.