Kueri dan filter instans GWLB dengan API ListLoadBalancers - GWLB

Menampilkan daftar instans Gateway Load Balancer (GWLB).

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:ListLoadBalancers

list

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ZoneIds	array	No	Daftar ID zona. Anda dapat mengkueri hingga 20 ID zona sekaligus.
	string	No	ID zona.	cn-beijing-h
VpcIds	array	No	Daftar ID virtual private cloud (VPC). Anda dapat mengkueri hingga 20 ID VPC sekaligus.
	string	No	ID VPC.	vpc-bp1xuejaht4o7yhh2****
AddressIpVersion	string	No	Versi protokol. Nilai yang valid: Ipv4: IPv4. Valid values: IPv4 : IPv4 DualStack : Dual-stack	Ipv4
LoadBalancerStatus	string	No	Status instans GWLB. Nilai yang valid: Active: Instans sedang berjalan. Inactive: Instans dihentikan. Pada status ini, listener instans tidak meneruskan traffic. Provisioning: Instans sedang dibuat. Configuring: Instans sedang dimodifikasi.	Active
LoadBalancerBusinessStatus	string	No	Status bisnis instans GWLB. Nilai yang valid: Normal: Instans berjalan sesuai harapan. FinancialLocked: Instans dikunci karena pembayaran tertunda.	Normal
LoadBalancerNames	array	No	Daftar nama instans GWLB. Anda dapat mengkueri hingga 20 nama instans sekaligus.
	string	No	Nama instans GWLB.	testGwlbName
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-aek2htf5qsyrn****
LoadBalancerIds	array	No	Daftar ID instans GWLB. Anda dapat mengkueri hingga 20 ID instans sekaligus.
	string	No	ID instans GWLB.	gwlb-cp6prgqy40hols****
TrafficMode	string	No	Mode traffic. Nilai yang valid: LoadBalance: Instans berada dalam mode load balancing. ByPass: Instans berada dalam mode bypass.	LoadBalance
Tag	array<object>	No	Daftar tag. Anda dapat menentukan hingga 20 tag dalam setiap panggilan.
	object	No	Objek 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://`.	testTagKey
Value	string	No	Nilai tag. Panjang nilai tag dapat mencapai 256 karakter dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
NextToken	string	No	Token yang digunakan untuk kueri berikutnya. Nilai yang valid: Jika NextToken kosong, berarti tidak ada kueri berikutnya yang perlu dikirim. Jika NextToken memiliki nilai, maka nilai tersebut adalah token yang digunakan untuk kueri berikutnya.	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	No	Jumlah entri yang ditampilkan per halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
Skip	integer	No	Jumlah entri yang dilewati.	1

Elemen respons

Element	Type	Description	Example
	object
LoadBalancers	array<object>	Daftar instans GWLB.
	array<object>	Instans GWLB.
AddressIpVersion	string	Versi protokol. Nilai yang valid: IPv4: IPv4.	IPv4
CreateTime	string	Waktu saat resource dibuat. Waktu ditampilkan dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	Status bisnis instans GWLB. Nilai yang valid: Normal: Instans berjalan sesuai harapan. FinancialLocked: Instans dikunci karena pembayaran tertunda.	Normal
LoadBalancerId	string	ID instans GWLB.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	Nama instans GWLB. Nama harus terdiri dari 2 hingga 128 karakter, diawali dengan huruf atau karakter Tionghoa, serta dapat mengandung angka, titik (.), garis bawah (_), dan tanda hubung (-).	testGwlbName
LoadBalancerStatus	string	Status instans GWLB. Nilai yang valid: Active: Instans sedang berjalan. Inactive: Instans dihentikan. Pada status ini, listener instans tidak meneruskan traffic. Provisioning: Instans sedang dibuat. Configuring: Instans sedang dimodifikasi.	Active
ResourceGroupId	string	ID kelompok sumber daya.	rg-aek26jasguy****
Tags	array<object>	Daftar tag.
	object	Tag.
Key	string	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://`.	testTagKey
Value	string	Nilai tag. Anda dapat menentukan hingga 20 nilai tag. Nilai tag dapat berupa string kosong. Panjang nilai tag dapat mencapai 128 karakter, harus diawali dengan huruf atau karakter Tionghoa, serta dapat mengandung angka, titik (.), garis bawah (_), dan tanda hubung (-). Nilai tag tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
VpcId	string	ID VPC.	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	Daftar pemetaan antara zona dan vSwitch. Anda harus menambahkan minimal satu zona dan dapat menambahkan hingga 20 zona. Jika wilayah saat ini mendukung dua zona atau lebih, kami menyarankan agar Anda menambahkan dua zona atau lebih.
	array<object>	Pemetaan antara zona dan vSwitch.
LoadBalancerAddresses	array<object>	Daftar alamat instans GWLB.
	object	Alamat instans GWLB.
EniId	string	ID elastic network interface (ENI).	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	Alamat IPv4 privat.	192.168.XX.XX
VSwitchId	string	vSwitch di zona tersebut. Setiap zona menggunakan satu vSwitch dan satu subnet secara default.	vsw-2zemule5dz7okwqfv****
ZoneId	string	ID zona. Anda dapat memanggil operasi DescribeZones untuk mengkueri daftar zona terbaru.	cn-hangzhou-g
MaxResults	integer	Jumlah entri yang ditampilkan per halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
NextToken	string	Token yang digunakan untuk kueri berikutnya. Nilai yang valid: Anda tidak perlu menentukan parameter ini pada permintaan pertama atau jika tidak ada permintaan lanjutan yang akan dikirim. Jika permintaan lanjutan akan dikirim, atur nilainya ke nilai `NextToken` yang dikembalikan dari panggilan API sebelumnya.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	ID permintaan.	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	Total jumlah entri yang dikembalikan.	100

Contoh

Respons sukses

JSONformat

{
  "LoadBalancers": [
    {
      "AddressIpVersion": "IPv4",
      "CreateTime": "2024-08-05T18:24:07Z",
      "LoadBalancerBusinessStatus": "Normal",
      "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
      "LoadBalancerName": "testGwlbName",
      "LoadBalancerStatus": "Active",
      "ResourceGroupId": "rg-aek26jasguy****",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-uf6eg0vndlsa84n7r****",
      "ZoneMappings": [
        {
          "LoadBalancerAddresses": [
            {
              "EniId": "eni-bp17qv9zbzyqy629****",
              "PrivateIpv4Address": "192.168.XX.XX"
            }
          ],
          "VSwitchId": "vsw-2zemule5dz7okwqfv****",
          "ZoneId": "cn-hangzhou-g"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****",
  "RequestId": "378A80E9-4262-5D8E-8D62-0969E52D7358",
  "TotalCount": 100
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.