All Products
Search

This Product

    ENS:DescribeLoadBalancerUDPListenerAttribute

    Document Center

    ENS:DescribeLoadBalancerUDPListenerAttribute

    Last Updated:Jun 11, 2026

    Memanggil DescribeLoadBalancerUDPListenerAttribute untuk mengkueri konfigurasi listener UDP.

    Deskripsi operasi

    • Laju panggilan API: 100 panggilan per detik.

    • Laju panggilan per pengguna: 10 panggilan per detik.

    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

    ens:DescribeLoadBalancerUDPListenerAttribute

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ListenerPort

    integer

    Yes

    Port listener yang akan dikueri. Nilai yang valid: 1 hingga 65535.

    80
    LoadBalancerId

    string

    Yes

    ID instans Server Load Balancer (SLB).

    lb-5pzipr2fszqtl2xf64uy5****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Respons

    RequestId

    string

    ID permintaan.

    5D7597CF-1630-54EC-A945-624A33F2E7E8
    ListenerPort

    integer

    Port listener.

    80
    Status

    string

    Status listener saat ini. Nilai yang valid:

    • Running: Listener berjalan dengan normal.

    • Stopped: Listener dihentikan.

    • Starting: Listener sedang dimulai.

    • Configuring: Listener sedang dikonfigurasi.

    • Stopping: Listener sedang dihentikan.

    Stopped
    Bandwidth

    integer

    Bandwidth puncak instans SLB. Nilai default adalah -1, yang menunjukkan bahwa bandwidth tidak dibatasi.

    5
    Scheduler

    string

    Algoritma penjadwalan. Nilai yang valid:

    • wrr: Server backend dengan bobot lebih tinggi menerima lebih banyak permintaan daripada yang berbobot lebih rendah.

    • wlc: Permintaan didistribusikan berdasarkan bobot dan beban setiap server backend. Beban mengacu pada jumlah koneksi ke server backend. Jika beberapa server backend memiliki bobot yang sama, permintaan diteruskan ke server backend dengan jumlah koneksi paling sedikit.

    • rr: Permintaan didistribusikan ke server backend secara berurutan berdasarkan urutan penerimaannya.

    • sch: Hashing konsisten berdasarkan alamat IP sumber. Permintaan dari alamat IP sumber yang sama diteruskan ke server backend yang sama.

    • tch: Hashing konsisten berdasarkan empat faktor (alamat IP sumber, alamat IP tujuan, port sumber, dan port tujuan). Permintaan yang berisi informasi yang sama berdasarkan empat faktor sebelumnya diteruskan ke server backend yang sama.

    • qch: Hashing konsisten berdasarkan ID koneksi QUIC. Permintaan dengan ID koneksi QUIC yang sama diteruskan ke server backend yang sama.

    • iqch: Hashing konsisten berdasarkan tiga byte tertentu dari iQUIC CID. Permintaan yang byte kedua hingga keempatnya sama diteruskan ke server backend yang sama.

    wrr
    HealthCheck

    string

    Menunjukkan apakah pemeriksaan kesehatan diaktifkan. Nilai yang valid:

    • on: diaktifkan.

    • off: dinonaktifkan.

    on
    HealthyThreshold

    integer

    Jumlah pemeriksaan kesehatan berturut-turut yang berhasil yang harus terjadi sebelum server backend dinyatakan sehat (success, server backend dapat dijangkau) dari tidak sehat (fail, server backend tidak dapat dijangkau). Nilai yang valid: 2 hingga 10.

    Catatan

    Parameter ini berlaku hanya jika HealthCheck disetel ke on.

    4
    UnhealthyThreshold

    integer

    Jumlah pemeriksaan kesehatan berturut-turut yang gagal yang harus terjadi sebelum server backend dinyatakan tidak sehat (fail, server backend tidak dapat dijangkau) dari sehat (success, server backend dapat dijangkau). Nilai yang valid: 2 hingga 10.

    Catatan

    Parameter ini berlaku hanya jika HealthCheck disetel ke on.

    4
    HealthCheckConnectTimeout

    integer

    Periode batas waktu maksimum untuk menunggu respons dari pemeriksaan kesehatan. Jika ENS backend tidak merespons dalam periode yang ditentukan, pemeriksaan kesehatan gagal.

    • Nilai default: 5 detik.

    • Nilai yang valid: 1 hingga 300.

    • Satuan: detik.

    Catatan

    • Parameter ini berlaku hanya jika HealthCheck disetel ke on.

    • Jika nilai HealthCheckConnectTimeout lebih kecil dari nilai HealthCheckInterval, nilai HealthCheckConnectTimeout menjadi tidak valid, dan nilai HealthCheckInterval digunakan sebagai periode batas waktu.

    100
    HealthCheckInterval

    integer

    Interval antara dua pemeriksaan kesehatan berturut-turut. Nilai yang valid: 1 hingga 50. Satuan: detik.

    Catatan

    Parameter ini berlaku hanya jika HealthCheck disetel ke on.

    5
    Description

    string

    Nama listener.

    example
    BackendServerPort

    integer

    Port yang digunakan oleh server backend instans SLB. Nilai yang valid: 1 hingga 65535.

    8080
    HealthCheckConnectPort

    integer

    Port yang digunakan untuk pemeriksaan kesehatan. Nilai yang valid: 1 hingga 65535. Jika parameter ini tidak ditentukan, port server backend (BackendServerPort) digunakan.

    8000
    HealthCheckReq

    string

    String permintaan untuk pemeriksaan kesehatan listener UDP. String hanya boleh berisi huruf dan angka, dan dapat memiliki panjang hingga 64 karakter.

    hello
    HealthCheckExp

    string

    String respons untuk pemeriksaan kesehatan listener UDP. String hanya boleh berisi huruf dan angka, dan dapat memiliki panjang hingga 64 karakter.

    ok
    EipTransmit

    string

    Menunjukkan apakah transmisi transparan EIP diaktifkan. Nilai yang valid:

    • on: diaktifkan.

    • off (default): dinonaktifkan.

    on
    EstablishedTimeout

    integer

    Periode batas waktu koneksi. Nilai yang valid: 10 hingga 900. Satuan: detik.

    500

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "5D7597CF-1630-54EC-A945-624A33F2E7E8",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": 5,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "HealthCheckReq": "hello",
  "HealthCheckExp": "ok",
  "EipTransmit": "on",
  "EstablishedTimeout": 500
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 ListenerNotFound Listener is not found.
    400 LoadBalancerNotFound The input parameter LoadBalancerId that is not found.
    400 ens.interface.error Failed to call API.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.