Daftar GWLB Listener melalui ListListeners API - Gateway Load Balancer

Mengambil daftar listener untuk Gateway Load Balancer.

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

gwlb:ListListeners

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ListenerIds	array	No	ID listener. Anda dapat menentukan hingga 20 ID listener.
	string	No	ID listener.	lsn-w3t3vpgjj12b2i****
LoadBalancerIds	array	No	ID instans Gateway Load Balancer (GWLB). Anda dapat menentukan hingga 20 ID instans.
	string	No	ID instans Gateway Load Balancer (GWLB).	gwlb-rbtjolkkbudmrr****
NextToken	string	No	Token yang digunakan untuk kueri berikutnya. Nilai yang valid: Jika NextToken kosong, tidak ada kueri lanjutan yang dilakukan. Jika nilai dikembalikan untuk NextToken, nilai tersebut adalah token yang digunakan untuk kueri berikutnya.	d209f4e63ec942c967c50c888a13****
MaxResults	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
Tag	array<object>	No	Tag. Anda dapat menentukan hingga 20 tag dalam setiap panggilan.
	object	No	Tag.
Key	string	No	Kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag dapat mencapai 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh mengandung `http://` atau `https://`.	tagKey
Value	string	No	Nilai tag. Panjang nilai tag dapat mencapai 256 karakter dan tidak boleh mengandung `http://` atau `https://`.	tagValue
Skip	integer	No	Jumlah entri yang dilewati untuk kueri terpaginasi.	10

Elemen respons

Element	Type	Description	Example
	object	Data yang dikembalikan.
Listeners	array<object>	Daftar listener untuk instans Gateway Load Balancer (GWLB).
	array<object>	Informasi mengenai listener.
ListenerDescription	string	Deskripsi listener.	listener-description
ListenerId	string	ID listener.	lsn-vu7folhh5ntm8u****
ListenerStatus	string	Status listener. Nilai yang valid: Provisioning: Listener sedang dibuat. Running: Listener sedang berjalan. Configuring: Listener sedang dikonfigurasi. Deleting: Listener sedang dihapus.	Running
LoadBalancerId	string	ID instans Gateway Load Balancer (GWLB).	gwlb-uf6hbeh795xlqln7g****
ServerGroupId	string	ID kelompok server.	sgp-5yapcb422i51ru****
TcpIdleTimeout	integer	Periode timeout untuk koneksi TCP yang idle.	350
Tags	array<object>	Tag.
	object	Tag.
Key	string	Kunci tag.	testKey
Value	string	Nilai tag.	testValue
MaxResults	integer	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
NextToken	string	Token yang digunakan untuk kueri berikutnya. Nilai yang valid: Jika NextToken kosong, tidak ada kueri lanjutan yang dilakukan. Jika nilai dikembalikan untuk NextToken, nilai tersebut adalah token yang digunakan untuk kueri berikutnya.	5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****
RequestId	string	ID permintaan.	7DBFC67C-A272-5952-8287-6C3EBE4E04D9
TotalCount	integer	Jumlah total entri.	8

Contoh

Respons sukses

JSONformat

{
  "Listeners": [
    {
      "ListenerDescription": "listener-description",
      "ListenerId": "lsn-vu7folhh5ntm8u****",
      "ListenerStatus": "Running",
      "LoadBalancerId": "gwlb-uf6hbeh795xlqln7g****",
      "ServerGroupId": "sgp-5yapcb422i51ru****",
      "TcpIdleTimeout": 350,
      "Tags": [
        {
          "Key": "testKey",
          "Value": "testValue"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****",
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9",
  "TotalCount": 8
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.