Kueri grup server GWLB berdasarkan tipe dan ID melalui ListServerGroups API - Gateway Load Balancer

Menampilkan daftar Server Groups.

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

get

ServerGroup

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

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

VPC

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ServerGroupIds	array	No	ID dari server groups. Anda dapat menentukan hingga 20 ID.
	string	No	ID dari server group.	sgp-atstuj3rtoptyui****
ServerGroupNames	array	No	Nama dari server groups. Anda dapat menentukan hingga 20 nama.
	string	No	Nama dari server group.	testServerGroupName
ServerGroupType	string	No	Tipe server group. Nilai yang valid: Instance: Server group berbasis instans. Anda dapat menambahkan server backend jenis berikut ke grup ini: ECS (Elastic Compute Service), ENI (Elastic Network Interface), dan ECI (Elastic Container Instance). Ip: Server group berbasis IP. Anda dapat menambahkan server backend ke grup ini dengan menentukan alamat IP-nya.	Instance
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-atstuj3rtop****
Tag	array<object>	No	Tag yang digunakan untuk memfilter server groups. Anda dapat menentukan hingga 20 tag.
	object	No	Sebuah tag.
Key	string	No	Kunci tag. Panjang kunci berkisar antara 1 hingga 128 karakter, dan tidak boleh diawali dengan `aliyun` atau `acs:`, serta tidak boleh mengandung `http://` atau `https://`.	testTagKey
Value	string	No	Nilai tag. Panjang nilai berkisar antara 1 hingga 256 karakter, dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
VpcId	string	No	ID virtual private cloud (VPC).	vpc-bp15zckdt37pq72zv****
NextToken	string	No	Token yang digunakan untuk kueri berikutnya. Nilai yang valid: Jika parameter NextToken kosong, tidak ada kueri berikutnya yang akan dikirim. Jika nilai dikembalikan untuk parameter NextToken, nilai tersebut merupakan token yang digunakan untuk kueri berikutnya.	FFmyTO70tTpLG6I3FmYAXGKPd****
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 sebelum mengembalikan hasil.	1

Elemen respons

Element	Type	Description	Example
	object	Data respons.
MaxResults	integer	Jumlah entri per halaman. Nilai yang valid: 1 hingga 1000.	20
NextToken	string	Token yang digunakan untuk kueri berikutnya. Jika `NextToken` kosong, tidak ada kueri berikutnya yang akan dikirim. Jika nilai dikembalikan untuk `NextToken`, nilai tersebut merupakan token yang menentukan titik awal kueri berikutnya.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	ID permintaan.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroups	array<object>	Daftar grup server backend.
	array<object>	Grup server backend.
ConnectionDrainConfig	object	Konfigurasi Pengurasan koneksi.
ConnectionDrainEnabled	boolean	Menunjukkan apakah Pengurasan koneksi diaktifkan. Nilai yang valid: true: diaktifkan false: dinonaktifkan	false
ConnectionDrainTimeout	integer	Periode timeout Pengurasan koneksi. Unit: detik. Nilai yang valid: 1 hingga 3600.	300
CreateTime	string	Waktu saat resource dibuat. Waktu ditampilkan dalam UTC dengan format `yyyy-MM-ddTHH:mm:ssZ`.	2024-08-05T18:24:07Z
HealthCheckConfig	object	Konfigurasi Pemeriksaan kesehatan.
HealthCheckConnectPort	integer	Port yang digunakan untuk Pemeriksaan kesehatan pada server backend. Nilai yang valid: 1 hingga 65535.	80
HealthCheckConnectTimeout	integer	Periode timeout maksimum untuk respons Pemeriksaan kesehatan. Unit: detik. Nilai yang valid: 1 hingga 300.	5
HealthCheckDomain	string	Nama domain yang digunakan untuk Pemeriksaan kesehatan. Nilai yang valid: $SERVER_IP: alamat IP pribadi server backend. domain: nama domain tertentu. Nama domain harus terdiri dari 1 hingga 80 karakter, dan dapat berisi huruf kecil, angka, tanda hubung (-), dan titik (.). Catatan Parameter ini hanya berlaku ketika `HealthCheckProtocol` diatur ke `HTTP`.	$SERVER_IP
HealthCheckEnabled	boolean	Menunjukkan apakah Pemeriksaan kesehatan diaktifkan. Nilai yang valid: true: diaktifkan false: dinonaktifkan	true
HealthCheckHttpCode	array	Daftar kode status HTTP.
	string	Kode status HTTP. Beberapa kode status HTTP dipisahkan dengan koma (,). Nilai yang valid: http_2xx http_3xx http_4xx http_5xx Nilai default: http_2xx. Catatan Parameter ini hanya berlaku ketika `HealthCheckProtocol` diatur ke `HTTP`.	http_2xx
HealthCheckInterval	integer	Interval pelaksanaan Pemeriksaan kesehatan. Unit: detik. Nilai yang valid: 1 hingga 50.	10
HealthCheckPath	string	Jalur yang digunakan untuk Pemeriksaan kesehatan. Jalur harus terdiri dari 1 hingga 80 karakter, dan dapat berisi huruf, angka, serta karakter khusus berikut: `- / . % ? # &`. Nilai harus diawali dengan garis miring (/). Catatan Parameter ini hanya berlaku ketika `HealthCheckProtocol` diatur ke `HTTP`.	/test/index.html
HealthCheckProtocol	string	Protokol yang digunakan untuk Pemeriksaan kesehatan. Nilai yang valid: TCP: Sistem mengirim paket SYN ke server untuk memeriksa apakah port tersebut dapat dijangkau. HTTP: Sistem mengirim permintaan GET ke server untuk memeriksa apakah aplikasi server dalam kondisi sehat.	TCP
HealthyThreshold	integer	Jumlah Pemeriksaan kesehatan berturut-turut yang berhasil sebelum server backend dinyatakan sehat (dari tidak sehat menjadi sehat). Nilai yang valid: 2 hingga 10.	2
UnhealthyThreshold	integer	Jumlah Pemeriksaan kesehatan berturut-turut yang gagal sebelum server backend dinyatakan tidak sehat (dari sehat menjadi tidak sehat). Nilai yang valid: 2 hingga 10.	2
HealthCheckReq	string
HealthCheckExp	string
Protocol	string	Protokol backend. Nilai yang valid: GENEVE	GENEVE
RelatedLoadBalancerIds	array	ID instans GWLB yang terkait.
	string	ID instans GWLB yang terkait.	gwlb-cp6prgqy40hols****
ResourceGroupId	string	ID kelompok sumber daya.	rg-atstuj3rtop****
Scheduler	string	Algoritma penjadwalan. Nilai yang valid: 5TCH (5-tuple consistent hash): Hash 5-tupel dihitung berdasarkan alamat IP sumber, alamat IP tujuan, port sumber, port tujuan, dan protokol. Paket dengan 5-tupel yang sama diteruskan ke server backend yang sama. 3TCH (3-tuple consistent hash): Hash 3-tupel dihitung berdasarkan alamat IP sumber, alamat IP tujuan, dan protokol. Paket dengan 3-tupel yang sama diteruskan ke server backend yang sama. 2TCH (2-tuple consistent hash): Hash 2-tupel dihitung berdasarkan alamat IP sumber dan alamat IP tujuan. Paket dengan 2-tupel yang sama diteruskan ke server backend yang sama.	5TCH
ServerCount	integer	Jumlah server backend.	2
ServerGroupId	string	ID server group.	sgp-atstuj3rtoptyui****
ServerGroupName	string	Nama server group.	testServerGroupName
ServerGroupStatus	string	Status server group. Nilai yang valid: Creating Available Configuring	Available
ServerGroupType	string	Tipe server group. Nilai yang valid: Instance: memungkinkan Anda menambahkan server tipe ECS, ENI, dan ECI. Ip: memungkinkan Anda menambahkan server dengan menentukan alamat IP.	Instance
ServerFailoverMode	string	Metode yang digunakan untuk menangani koneksi yang sedang berlangsung ketika server dinyatakan tidak sehat. Nilai yang valid: NoRebalance: Koneksi yang sedang berlangsung tidak diseimbangkan ulang. Rebalance: Koneksi yang sedang berlangsung diseimbangkan ulang.	NoRebalance
Tags	array<object>	Daftar tag.
	object	Tag.
Key	string	Kunci tag. Kunci tag tidak boleh berupa string kosong. Panjang kunci tag hingga 128 karakter dan tidak boleh diawali dengan `aliyun` atau `acs:`. Tidak boleh mengandung `http://` atau `https://`.	testTagKey
Value	string	Nilai tag. Panjang nilai tag hingga 256 karakter dan tidak boleh mengandung `http://` atau `https://`.	testTagValue
VpcId	string	ID virtual private cloud (VPC).	vpc-bp15zckdt37pq72zv****
TotalCount	integer	Total jumlah entri yang dikembalikan.	1

Contoh

Respons sukses

JSONformat

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups": [
    {
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "CreateTime": "2024-08-05T18:24:07Z",
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckConnectTimeout": 5,
        "HealthCheckDomain": "$SERVER_IP",
        "HealthCheckEnabled": true,
        "HealthCheckHttpCode": [
          "http_2xx"
        ],
        "HealthCheckInterval": 10,
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "TCP",
        "HealthyThreshold": 2,
        "UnhealthyThreshold": 2,
        "HealthCheckReq": "",
        "HealthCheckExp": ""
      },
      "Protocol": "GENEVE",
      "RelatedLoadBalancerIds": [
        "gwlb-cp6prgqy40hols****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "5TCH",
      "ServerCount": 2,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerGroupName": "testServerGroupName",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "ServerFailoverMode": "NoRebalance",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-bp15zckdt37pq72zv****"
    }
  ],
  "TotalCount": 1
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.