Referensi API GetLoadBalancerAttribute untuk GWLB - Server Load Balancer

Mengambil detail 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:GetLoadBalancerAttribute

get

*LoadBalancer

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	ID instans GWLB.	gwlb-9njtjmqt7zfcqm****

Elemen respons

Element	Type	Description	Example
	object
AddressIpVersion	string	Versi protokol. Nilai yang valid: Ipv4: IPv4.	IPv4
CreateTime	string	Waktu saat resource dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2024-07-08T10:12:58Z
LoadBalancerBusinessStatus	string	Status bisnis instans GWLB. Nilai yang valid: Normal: berjalan sebagaimana mestinya FinancialLocked: terkunci karena pembayaran tertunda	Normal
LoadBalancerId	string	ID instans GWLB.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	Nama instans GWLB. Nama harus terdiri dari 2 hingga 128 karakter, dan dapat berisi huruf, angka, titik (.), garis bawah (_), serta tanda hubung (-). Nama harus dimulai dengan huruf.	gwlb
LoadBalancerStatus	string	Status instans GWLB. Nilai yang valid: Active: Instans GWLB sedang berjalan. Inactive: Instans GWLB dinonaktifkan. Listener pada instans GWLB dengan status Inactive tidak meneruskan traffic. Provisioning: Instans GWLB sedang dibuat. Configuring: Instans GWLB sedang dimodifikasi.	Active
RequestId	string	ID permintaan.	B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmx7pmxcy****
Tags	array<object>	Tag.
	object	Informasi tentang tag.
Key	string	Kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag maksimal 128 karakter. Kunci tag tidak boleh diawali dengan `aliyun` atau `acs:`, serta tidak boleh mengandung `http://` atau `https://`.	testTagKey
Value	string	Nilai tag. Panjang nilai tag maksimal 256 karakter dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
VpcId	string	ID VPC.	vpc-k1aajsbwbaq4todet****
ZoneMappings	array<object>	Pemetaan antara zona dan vSwitch. Anda harus menentukan minimal satu zona. Anda dapat menentukan maksimal 20 zona. Jika wilayah mendukung dua zona atau lebih, tentukan minimal dua zona.
	array<object>	Informasi tentang zona dan vSwitch.
LoadBalancerAddresses	array<object>	Alamat instans GWLB.
	object	Detail alamat instans GWLB.
EniId	string	ID elastic network interface (ENI) yang digunakan oleh instans GWLB.	eni-bp1iahwz3rzgvltz****
PrivateIpv4Address	string	Alamat IPv4 privat.	192.168.XX.XX
VSwitchId	string	vSwitch di zona tersebut. Anda hanya dapat menentukan satu vSwitch (subnet) di setiap zona untuk instans GWLB.	vsw-uf6v8l7d2f1k53xrl****
ZoneId	string	ID zona.	cn-hangzhou-j
TrafficMode	string	Mode pemrosesan traffic. Nilai yang valid: LoadBalance: mode load balancing. GWLB meneruskan traffic ke server backend. ByPass: mode bypass. GWLB langsung mengembalikan traffic ke titik akhir GWLB tanpa meneruskannya ke server backend.	LoadBalance

Contoh

Respons sukses

JSONformat

{
  "AddressIpVersion": "IPv4",
  "CreateTime": "2024-07-08T10:12:58Z",
  "LoadBalancerBusinessStatus": "Normal",
  "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
  "LoadBalancerName": "gwlb",
  "LoadBalancerStatus": "Active",
  "RequestId": "B6DC5DDC-9560-59BF-80FA-ED1E5CB417DF",
  "ResourceGroupId": "rg-acfmx7pmxcy****",
  "Tags": [
    {
      "Key": "testTagKey",
      "Value": "testTagValue"
    }
  ],
  "VpcId": "vpc-k1aajsbwbaq4todet****",
  "ZoneMappings": [
    {
      "LoadBalancerAddresses": [
        {
          "EniId": "eni-bp1iahwz3rzgvltz****",
          "PrivateIpv4Address": "192.168.XX.XX"
        }
      ],
      "VSwitchId": "vsw-uf6v8l7d2f1k53xrl****",
      "ZoneId": "cn-hangzhou-j"
    }
  ],
  "TrafficMode": "LoadBalance"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.
400	MissingParam.LoadBalancerId	The param of LoadBalancerId is missing.	Load balancing ID parameter missing

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.