Daftar GWLB Listener melalui ListListeners API - Gateway Load Balancer - Alibaba Cloud - Server Load Balancer

Mengkueri daftar pendengar 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	Daftar ID Pendengar. Anda dapat menentukan hingga 20 ID Pendengar.
	string	No	The listener ID.	lsn-w3t3vpgjj12b2i****
LoadBalancerIds	array	No	ID instans Gateway Load Balancer (GWLB). Anda dapat menentukan hingga 20 ID instans.
	string	No	The ID of the Gateway Load Balancer (GWLB) instance.	gwlb-rbtjolkkbudmrr****
NextToken	string	No	Token yang digunakan untuk kueri berikutnya. Nilai valid: Jika NextToken kosong, tidak ada kueri berikutnya yang dilakukan. Jika nilai dikembalikan untuk NextToken, nilai tersebut adalah token yang digunakan untuk kueri berikutnya.	d209f4e63ec942c967c50c888a13****
MaxResults	integer	No	Jumlah entri yang dikembalikan pada setiap halaman. Nilai valid: 1 hingga 1000. Nilai default: 20.	20
Tag	array<object>	No	Tag. Anda dapat menentukan hingga 20 tag dalam setiap panggilan.
	object	No	The tag.
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	tagKey
Value	string	No	The tag value. The tag value can be up to 256 characters in length and cannot contain `http://` or `https://`.	tagValue
Skip	integer	No	Jumlah entri yang dilewati untuk kueri berhalaman.	10

Elemen respons

Element	Type	Description	Example
	object	The returned data.
Listeners	array<object>	A list of listeners for the Gateway Load Balancer (GWLB) instance.
	array<object>	The information about the listener.
ListenerDescription	string	The description of the listener.	listener-description
ListenerId	string	The listener ID.	lsn-vu7folhh5ntm8u****
ListenerStatus	string	The status of the listener. Valid values: Provisioning: The listener is being created. Running: The listener is running. Configuring: The listener is being configured. Deleting: The listener is being deleted.	Running
LoadBalancerId	string	The ID of the Gateway Load Balancer (GWLB) instance.	gwlb-uf6hbeh795xlqln7g****
ServerGroupId	string	The server group ID.	sgp-5yapcb422i51ru****
TcpIdleTimeout	integer	The timeout period of an idle TCP connection.	350
Tags	array<object>	The tags.
	object	The tags.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
MaxResults	integer	The number of entries returned on each page. Valid values: 1 to 1000. Default value: 20.	20
NextToken	string	The token that is used for the next query. Valid values: If NextToken is empty, no subsequent query is performed. If a value is returned for NextToken, the value is the token that is used for the next query.	5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****
RequestId	string	The request ID.	7DBFC67C-A272-5952-8287-6C3EBE4E04D9
TotalCount	integer	The total number of entries.	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.