All Products
Search

This Product

    ENS:DescribeLoadBalancerTCPListenerAttribute

    Document Center

    ENS:DescribeLoadBalancerTCPListenerAttribute

    Last Updated:Jun 11, 2026

    Mengkueri konfigurasi Listener TCP dengan memanggil DescribeLoadBalancerTCPListenerAttribute.

    Deskripsi operasi

    • Frekuensi panggilan API: 100 panggilan per detik.

    • Frekuensi 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:DescribeLoadBalancerTCPListenerAttribute

    get

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ListenerPort

    integer

    Yes

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

    80
    LoadBalancerId

    string

    Yes

    ID instans load balancing.

    lb-5snthcyu1x10g7tywj7iu****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Skema Tanggapan.

    RequestId

    string

    ID permintaan.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    ListenerPort

    integer

    Port antarmuka depan yang digunakan oleh instans load balancing.

    80
    Status

    string

    Status saat ini dari Pendengar. Nilai valid:

    • Running: Berjalan sesuai harapan.

    • Stopped: Dihentikan.

    • Starting: Sedang dimulai.

    • Configuring: Sedang dikonfigurasi.

    • Stopping: Sedang dihentikan.

    Stopped
    Bandwidth

    integer

    Bandwidth puncak load balancing. Nilai default adalah -1, yang menunjukkan bahwa bandwidth tidak dibatasi.

    -1
    Scheduler

    string

    Algoritma penjadwalan. Nilai valid:

    • wrr: Server backend dengan Bobot lebih tinggi menerima lebih banyak permintaan.

    • wlc: Permintaan didistribusikan berdasarkan Bobot dan jumlah Koneksi aktif setiap server backend. Jika dua server backend memiliki Bobot yang sama, server backend dengan Koneksi lebih sedikit menerima lebih banyak permintaan.

    • rr: Permintaan didistribusikan ke server backend secara berurutan.

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

    • tch: Penghashan konsisten berdasarkan Tupel 4 (alamat IP sumber, alamat IP tujuan, port sumber, dan port tujuan). Permintaan dari aliran yang sama didistribusikan ke server backend yang sama.

    wrr
    PersistenceTimeout

    integer

    Periode pengatur waktu persistensi sesi.

    • Nilai default: 0, yang menunjukkan bahwa persistensi sesi dinonaktifkan.

    • Nilai valid: 0 hingga 3600.

    • Unit: detik.

    0
    EstablishedTimeout

    integer

    Periode pengatur waktu koneksi. Nilai valid: 10 hingga 900. Unit: detik.

    500
    HealthCheck

    string

    Apakah Pemeriksaan kesehatan diaktifkan. Nilai valid:

    • on: diaktifkan.

    • off: dinonaktifkan.

    on
    HealthyThreshold

    integer

    Jumlah Pemeriksaan kesehatan berhasil berturut-turut yang diperlukan sebelum server backend dinyatakan sehat (dari gagal ke berhasil). Nilai valid: 2 hingga 10.

    Catatan

    Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    4
    UnhealthyThreshold

    integer

    Jumlah Pemeriksaan kesehatan gagal berturut-turut yang diperlukan sebelum server backend dinyatakan tidak sehat (dari berhasil ke gagal). Nilai valid: 2 hingga 10.

    Catatan

    Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    4
    HealthCheckConnectTimeout

    integer

    Pengatur waktu maksimum untuk menunggu tanggapan dari Pemeriksaan kesehatan. Jika backend ENS tidak merespons dalam waktu yang ditentukan, Pemeriksaan kesehatan gagal.

    • Nilai default: 5 detik.

    • Nilai valid: 1 hingga 300.

    • Unit: detik.

    Catatan

    • Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    • Jika nilai HealthCheckConnectTimeout kurang dari nilai HealthCheckInterval, HealthCheckConnectTimeout menjadi tidak efektif dan periode pengatur waktu diatur ke nilai HealthCheckInterval.

    100
    HealthCheckInterval

    integer

    Interval antara dua Pemeriksaan kesehatan berturut-turut. Nilai valid: 1 hingga 50. Unit: detik.

    5
    Description

    string

    Nama Pendengar.

    example
    HealthCheckHttpCode

    string

    Kode status HTTP yang menunjukkan Pemeriksaan kesehatan berhasil. Nilai valid:

    • http_2xx (default).

    • http_3xx.

    • http_4xx.

    • http_5xx.

    Catatan

    Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    http_2xx
    HealthCheckDomain

    string

    Nama domain yang digunakan untuk Pemeriksaan kesehatan.

    Catatan

    Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    example.com
    HealthCheckURI

    string

    URI yang digunakan untuk Pemeriksaan kesehatan. URI harus memiliki panjang 1 hingga 80 karakter.

    Catatan

    • URI tidak boleh hanya / tetapi harus dimulai dengan /.

    • Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    /example/index.html
    HealthCheckType

    string

    Tipe Pemeriksaan kesehatan. Nilai valid:

    • tcp (default).

    • http.

    tcp
    BackendServerPort

    integer

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

    8080
    HealthCheckConnectPort

    integer

    Port yang digunakan untuk Pemeriksaan kesehatan. Nilai valid: 1 hingga 65535. Jika parameter ini tidak dikonfigurasi di Pengaturan, port layanan backend (BackendServerPort) akan digunakan.

    Catatan

    Parameter ini hanya berlaku ketika HealthCheck diatur ke on.

    8000
    EipTransmit

    string

    Apakah penerusan EIP diaktifkan. Nilai valid:

    • on: diaktifkan.

    • off (default): dinonaktifkan.

    on

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "PersistenceTimeout": 0,
  "EstablishedTimeout": 500,
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "example.com",
  "HealthCheckURI": "/example/index.html",
  "HealthCheckType": "tcp",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "EipTransmit": "on"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 ens.interface.error An error occurred while call the API.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 ListenerNotFound Listener is not found.
    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.