Kueri dan filter instans GWLB dengan API ListLoadBalancers - GWLB - Alibaba Cloud - Server Load Balancer

Mencantumkan instance 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 melakukan kueri hingga 20 ID zona dalam satu waktu.
	string	No	ID zona.	cn-beijing-h
VpcIds	array	No	Daftar ID virtual private cloud (VPC). Anda dapat melakukan kueri hingga 20 ID VPC dalam satu waktu.
	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 instance GWLB. Nilai yang valid: Active: Instance sedang berjalan. Inactive: Instance dihentikan. Dalam keadaan ini, listener instance tidak meneruskan traffic. Provisioning: Instance sedang dibuat. Configuring: Instance sedang dimodifikasi.	Active
LoadBalancerBusinessStatus	string	No	Status bisnis instance GWLB. Nilai yang valid: Normal: Instance berjalan sesuai harapan. FinancialLocked: Instance terkunci karena pembayaran yang terlambat.	Normal
LoadBalancerNames	array	No	Daftar nama instance GWLB. Anda dapat melakukan kueri hingga 20 nama instance dalam satu waktu.
	string	No	Nama instance GWLB.	testGwlbName
ResourceGroupId	string	No	ID grup sumber daya.	rg-aek2htf5qsyrn****
LoadBalancerIds	array	No	Daftar ID instance GWLB. Anda dapat melakukan kueri hingga 20 ID instance dalam satu waktu.
	string	No	ID instance GWLB.	gwlb-cp6prgqy40hols****
TrafficMode	string	No	Mode traffic. Nilai yang valid: LoadBalance: Instance dalam mode load balancing. ByPass: Instance 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. Kunci tag dapat memiliki panjang hingga 128 karakter, dan tidak boleh diawali dengan `aliyun` atau `acs:`. Kunci tag tidak boleh berisi `http://` atau `https://`.	testTagKey
Value	string	No	Nilai tag. Nilai tag dapat memiliki panjang hingga 256 karakter dan tidak boleh berisi `http://` atau `https://`.	testTagValue
NextToken	string	No	Token yang digunakan untuk kueri berikutnya. Nilai yang valid: Jika NextToken kosong, ini menunjukkan bahwa tidak ada kueri berikutnya yang akan dikirim. Jika NextToken memiliki nilai, nilai tersebut adalah token yang digunakan untuk kueri berikutnya.	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	No	Jumlah entri yang akan dikembalikan di setiap halaman. Nilai yang valid: 1 hingga 1000. Nilai default: 20.	20
Skip	integer	No	Jumlah entri yang akan dilewati.	1

Elemen respons

Element	Type	Description	Example
	object
LoadBalancers	array<object>	Daftar instance GWLB.
	array<object>	Instance GWLB.
AddressIpVersion	string	Versi protokol. Nilai yang valid: IPv4: IPv4.	IPv4
CreateTime	string	Waktu saat sumber daya dibuat. Waktu ditampilkan dalam UTC dan mengikuti format yyyy-MM-ddTHH:mm:ssZ.	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	Status bisnis instance GWLB. Nilai yang valid: Normal: Instance berjalan sesuai harapan. FinancialLocked: Instance terkunci karena pembayaran yang terlambat.	Normal
LoadBalancerId	string	ID instance GWLB.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	Nama instance GWLB. Nama harus memiliki panjang 2 hingga 128 karakter, diawali dengan huruf atau karakter Mandarin, dan dapat berisi angka, titik (.), garis bawah (_), dan tanda hubung (-).	testGwlbName
LoadBalancerStatus	string	Status instance GWLB. Nilai yang valid: Active: Instance sedang berjalan. Inactive: Instance dihentikan. Dalam keadaan ini, listener instance tidak meneruskan traffic. Provisioning: Instance sedang dibuat. Configuring: Instance sedang dimodifikasi.	Active
ResourceGroupId	string	ID grup sumber daya.	rg-aek26jasguy****
Tags	array<object>	Daftar tag.
	object	Tag.
Key	string	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:`. It cannot contain `http://` or `https://`.	testTagKey
Value	string	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, must start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-). The tag value cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagValue
VpcId	string	ID VPC.	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	Daftar pemetaan antara zona dan vSwitch. Anda harus menambahkan setidaknya satu zona dan dapat menambahkan hingga 20 zona. Jika region saat ini mendukung dua atau lebih zona, kami menyarankan Anda menambahkan dua atau lebih zona.
	array<object>	Pemetaan antara sebuah zona dan vSwitch.
LoadBalancerAddresses	array<object>	The list of addresses of the GWLB instance.
	object	The address of the GWLB instance.
EniId	string	The ID of the elastic network interface (ENI).	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	The private IPv4 address.	192.168.XX.XX
VSwitchId	string	The vSwitch in the zone. Each zone uses a vSwitch and a subnet by default.	vsw-2zemule5dz7okwqfv****
ZoneId	string	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-g
MaxResults	integer	Jumlah entri yang dikembalikan di setiap 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 untuk permintaan pertama atau jika tidak ada permintaan berikutnya yang akan dikirim. Jika kueri berikutnya 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	Jumlah total 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.