ListServerGroups - Server Load Balancer

Mengambil daftar kelompok server.

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

alb:ListServerGroups

get

*ServerGroup

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ServerGroupIds	array	No	ID kelompok server.
	string	No	ID kelompok server yang akan ditanyakan. Anda dapat menentukan hingga 20 ID dalam setiap panggilan.	sgp-atstuj3rtop****
ServerGroupNames	array	No	Nama kelompok server yang akan ditanyakan. Anda dapat menentukan paling banyak 10 nama kelompok server.
	string	No	Nama kelompok server yang akan ditanyakan. Anda dapat menentukan hingga 10 nama kelompok server dalam setiap panggilan.	Group3
ResourceGroupId	string	No	ID kelompok sumber daya tempat kelompok server berada.	rg-atstuj3rtop****
NextToken	string	No	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai valid: Anda tidak perlu menentukan parameter ini untuk permintaan pertama. Anda harus menentukan token yang diperoleh dari kueri sebelumnya sebagai nilai NextToken.	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 100. Nilai default: 20.	20
VpcId	string	No	ID virtual private cloud (VPC).	vpc-bp15zckdt37pq72zv****
ServerGroupType	string	No	Jenis kelompok server. Nilai valid: Instance: instans, termasuk Instance ECS, ENI, dan instans kontainer elastis. Ip: alamat IP. Fc: Function Compute	Instance
Tag	array<object>	No	Tag yang ditambahkan ke kelompok server. Anda dapat menentukan hingga 10 tag dalam setiap panggilan.	Instance
	object	No	Tag yang ditambahkan ke kelompok server. Anda dapat menentukan paling banyak 10 tag dalam setiap panggilan.
Key	string	No	Kunci tag. Anda dapat menentukan hingga 10 kunci tag. Panjang kunci tag maksimal 64 karakter dan tidak boleh mengandung `http://` atau `https://`. Kunci tag tidak boleh diawali dengan `aliyun` atau `acs:`.	Test
Value	string	No	Nilai tag. Anda dapat menentukan hingga 10 nilai tag. Panjang nilai tag maksimal 128 karakter dan tidak boleh mengandung `http://` atau `https://`. Nilai tag tidak boleh diawali dengan `aliyun` atau `acs:`.	Test

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
MaxResults	integer	Jumlah entri yang dikembalikan per halaman.	50
NextToken	string	Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai valid: Jika NextToken kosong, tidak ada halaman berikutnya. Jika NextToken tidak kosong, nilai NextToken dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru.	caeba0bbb2be03f8****
RequestId	string	ID permintaan.	CEF72CEB-54B6-4AE8-B225-F876******
ServerGroups	array<object>	Kelompok server.
	array<object>	Kelompok server.
HealthCheckConfig	object	Konfigurasi pemeriksaan kesehatan.
HealthCheckConnectPort	integer	Port backend yang digunakan untuk pemeriksaan kesehatan. Nilai valid: 0 hingga 65535. Nilai 0 menunjukkan bahwa port server backend digunakan untuk pemeriksaan kesehatan.	80
HealthCheckEnabled	boolean	Menunjukkan apakah fitur pemeriksaan kesehatan diaktifkan. Nilai valid: true false	true
HealthCheckHost	string	Nama domain yang digunakan untuk pemeriksaan kesehatan. Backend Server Internal IP (default): Gunakan alamat IP internal server backend sebagai nama domain pemeriksaan kesehatan. Custom Domain Name: Masukkan nama domain. Panjang nama domain antara 1 hingga 80 karakter. Nama domain terdiri atas huruf kecil, angka, tanda hubung (-), dan titik (.). Nama domain mengandung setidaknya satu titik (.) tetapi tidak diawali atau diakhiri dengan titik (.). Label domain paling kanan hanya berisi huruf, dan tidak mengandung angka atau tanda hubung (-). Nama domain tidak diawali atau diakhiri dengan tanda hubung (-). Catatan Parameter ini hanya berlaku jika HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.	www.example.com
HealthCheckCodes	array	Kode status HTTP yang menunjukkan server backend dalam kondisi sehat.
	string	Kode status HTTP yang menunjukkan server backend dalam kondisi sehat. Ketika HealthCheckProtocol diatur ke HTTP atau HTTPS, Anda dapat mengatur HealthCheckCodes ke http_2xx, http_3xx, http_4xx, dan http_5xx. Beberapa kode status HTTP dipisahkan dengan koma (,). Ketika HealthCheckProtocol diatur ke gRPC, nilai valid HealthCheckCodes adalah 0 hingga 99. Rentang nilai didukung. Maksimal 20 rentang nilai didukung. Beberapa rentang nilai dipisahkan dengan koma (,). Catatan Parameter ini hanya berlaku jika HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.	http_2xx
HealthCheckHttpVersion	string	Versi HTTP yang digunakan untuk pemeriksaan kesehatan. Nilai valid: HTTP1.0 dan HTTP1.1. Catatan Parameter ini hanya berlaku jika HealthCheckProtocol diatur ke HTTP atau HTTPS.	HTTP1.1
HealthCheckInterval	integer	Interval pelaksanaan pemeriksaan kesehatan. Satuan: detik. Nilai valid: 1 hingga 50.	5
HealthCheckMethod	string	Metode HTTP yang digunakan untuk pemeriksaan kesehatan. Nilai valid: GET: Jika panjang respons melebihi 8 KB, respons tersebut dipotong. Namun, hasil pemeriksaan kesehatan tidak terpengaruh. POST: Pemeriksaan kesehatan gRPC menggunakan metode POST secara default. HEAD: Pemeriksaan kesehatan HTTP dan HTTPS menggunakan metode HEAD secara default. Catatan Parameter ini hanya berlaku jika HealthCheckProtocol diatur ke HTTP, HTTPS, atau gRPC.	HEAD
HealthCheckPath	string	URL yang digunakan untuk pemeriksaan kesehatan. Catatan Parameter ini hanya berlaku jika HealthCheckProtocol diatur ke HTTP atau HTTPS.	/test/index.html
HealthCheckProtocol	string	Protokol yang digunakan untuk pemeriksaan kesehatan. Nilai valid: HTTP: Pemeriksaan kesehatan HTTP mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk memeriksa ketersediaan server backend. HTTPS: Pemeriksaan kesehatan HTTPS mensimulasikan perilaku browser dengan mengirim permintaan HEAD atau GET untuk memeriksa ketersediaan server backend. HTTPS mendukung enkripsi dan memberikan keamanan lebih tinggi dibanding HTTP. TCP: Pemeriksaan kesehatan TCP mengirim paket TCP SYN ke server backend untuk memeriksa apakah port server backend dapat dijangkau. gRPC: Pemeriksaan kesehatan gRPC mengirim permintaan POST atau GET ke server backend untuk memeriksa apakah server backend dalam kondisi sehat.	HTTP
HealthCheckTimeout	integer	Masa tenggang respons pemeriksaan kesehatan. Jika server backend tidak merespons dalam masa tenggang yang ditentukan, server backend tersebut dinyatakan tidak sehat. Satuan: detik.	3
HealthyThreshold	integer	Jumlah kali server backend yang tidak sehat harus lulus pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan sehat. Dalam kasus ini, status kesehatan berubah dari fail menjadi success.	4
UnhealthyThreshold	integer	Jumlah kali server backend yang sehat harus gagal pemeriksaan kesehatan secara berturut-turut sebelum dinyatakan tidak sehat. Dalam kasus ini, status kesehatan berubah dari success menjadi fail.	4
Protocol	string	Protokol backend. Nilai valid: HTTP: memungkinkan Anda mengaitkan pendengar HTTPS, HTTP, atau QUIC dengan server backend. HTTPS: memungkinkan Anda mengaitkan pendengar HTTPS dengan server backend. GRPC: memungkinkan Anda mengaitkan pendengar HTTPS dan QUIC dengan server backend.	HTTP
RelatedLoadBalancerIds	array	ID instans ALB yang terkait dengan kelompok server.
	string	ID instans ALB.	alb-n5qw04uq8savfe****
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-atstuj3rtop****
Scheduler	string	Algoritma penjadwalan. Nilai valid: Wrr: Round-robin berbobot. Server backend dengan bobot lebih tinggi menerima lebih banyak permintaan daripada server backend dengan bobot lebih rendah. Wlc: jumlah koneksi paling sedikit dengan bobot. Permintaan didistribusikan berdasarkan bobot dan beban setiap server backend. Beban mengacu pada jumlah koneksi pada server backend. Jika beberapa server backend memiliki bobot yang sama, permintaan diteruskan ke server backend dengan jumlah koneksi paling sedikit. Sch: penghashan konsisten. Permintaan yang memiliki faktor hash yang sama didistribusikan ke server backend yang sama. Jika Anda tidak menentukan parameter UchConfig, alamat IP sumber digunakan sebagai faktor hash secara default. Permintaan yang berasal dari alamat IP yang sama didistribusikan ke server backend yang sama. Jika Anda menentukan parameter UchConfig, string URL digunakan sebagai faktor hash. Permintaan yang memiliki string URL yang sama didistribusikan ke server backend yang sama.	Wrr
ServerGroupId	string	ID kelompok server.	sgp-cige6j****
ServerGroupName	string	Nama kelompok server.	Group3
ServerGroupStatus	string	Status kelompok server. Nilai valid: Creating. Available Configuring	Available
ServerGroupType	string	Jenis kelompok server. Nilai valid: Instance: instans, termasuk Instance ECS, ENI, dan instans kontainer elastis. Ip: alamat IP. Fc: Function Compute	Instance
StickySessionConfig	object	Konfigurasi persistensi sesi.
Cookie	string	Cookie yang dikonfigurasi untuk server.	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	Masa tenggang cookie. Satuan: detik. Nilai valid: 1 hingga 86400. Catatan Parameter ini hanya berlaku ketika StickySessionEnabled diatur ke true dan StickySessionType diatur ke Insert.	1000
StickySessionEnabled	boolean	Menunjukkan apakah persistensi sesi diaktifkan. Nilai valid: true false	false
StickySessionType	string	Metode yang digunakan untuk menangani cookie. Nilai valid: insert: menyisipkan cookie. Saat pertama kali klien mengakses ALB, ALB menyisipkan cookie SERVERID ke dalam paket respons HTTP atau HTTPS. Permintaan selanjutnya dari klien yang membawa cookie ini diteruskan ke server backend yang sama seperti permintaan pertama. Server: menulis ulang cookie. ALB menulis ulang cookie kustom dalam permintaan dari klien. Permintaan selanjutnya dari klien yang membawa cookie baru tersebut diteruskan ke server backend yang sama seperti permintaan pertama.	Insert
VpcId	string	ID VPC tempat instans ALB berada.	vpc-bp15zckdt37pq72zv****
Tags	array<object>	Tag yang ditambahkan ke kelompok server.
	object	Tag yang ditambahkan ke kelompok server.
Key	string	Kunci tag.	Test
Value	string	Nilai tag.	Test
ConfigManagedEnabled	boolean	Menunjukkan apakah manajemen konfigurasi diaktifkan. Nilai valid: true false	false
UpstreamKeepaliveEnabled	boolean	Menunjukkan apakah koneksi TCP persisten diaktifkan. Nilai valid: true false	false
Ipv6Enabled	boolean	Menunjukkan apakah IPv6 didukung. Nilai valid: true false	false
ServerCount	integer	Jumlah server backend dalam kelompok server.	1
ServiceName	string	Nama kelompok server.	test
UchConfig	object	Konfigurasi penghashan konsisten berdasarkan URL.
Type	string	Jenis parameter. Nilai valid: QueryString.	QueryString
Value	string	Nilai hash.	abc
CreateTime	string	Waktu saat resource dibuat.	2022-07-02T02:49:05Z
ConnectionDrainConfig	object	Konfigurasi pengurasan koneksi. Setelah pengurasan koneksi diaktifkan, ALB mempertahankan transmisi data untuk periode waktu tertentu setelah server backend dihapus atau dinyatakan tidak sehat. Catatan Instans ALB dasar tidak mendukung pengurasan koneksi. Instans ALB Standar dan yang diaktifkan WAF mendukung pengurasan koneksi. Kelompok server jenis instance dan IP mendukung pengurasan koneksi. Kelompok server jenis Function Compute tidak mendukung pengurasan koneksi.
ConnectionDrainEnabled	boolean	Menunjukkan apakah pengurasan koneksi diaktifkan. Nilai valid: true false	false
ConnectionDrainTimeout	integer	Masa tenggang pengurasan koneksi.	300
SlowStartConfig	object	Konfigurasi mulai lambat. Setelah mulai lambat diaktifkan, ALB melakukan pra-ambil data ke server backend yang baru ditambahkan. Permintaan yang didistribusikan ke server backend tersebut meningkat secara bertahap. Catatan Instans ALB dasar tidak mendukung mulai lambat. Instans ALB Standar dan yang diaktifkan WAF mendukung mulai lambat. Kelompok server jenis instance dan IP mendukung mulai lambat. Kelompok server jenis Function Compute tidak mendukung mulai lambat. Mulai lambat hanya didukung oleh algoritma penjadwalan round-robin berbobot.
SlowStartEnabled	boolean	Menunjukkan apakah mulai lambat diaktifkan. Nilai valid: true false	false
SlowStartDuration	integer	Durasi mulai lambat.	30
CrossZoneEnabled	boolean	Menunjukkan apakah load balancing lintas zona diaktifkan. Nilai valid: true (default) false	true
TotalCount	integer	Total jumlah entri yang dikembalikan.	1000

Contoh

Respons sukses

JSONformat

{
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f8****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876******",
  "ServerGroups": [
    {
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckEnabled": true,
        "HealthCheckHost": "www.example.com",
        "HealthCheckCodes": [
          "http_2xx"
        ],
        "HealthCheckHttpVersion": "HTTP1.1",
        "HealthCheckInterval": 5,
        "HealthCheckMethod": "HEAD",
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "HTTP",
        "HealthCheckTimeout": 3,
        "HealthyThreshold": 4,
        "UnhealthyThreshold": 4
      },
      "Protocol": "HTTP",
      "RelatedLoadBalancerIds": [
        "alb-n5qw04uq8savfe****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "Wrr",
      "ServerGroupId": "sgp-cige6j****",
      "ServerGroupName": "Group3",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "StickySessionConfig": {
        "Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
        "CookieTimeout": 1000,
        "StickySessionEnabled": false,
        "StickySessionType": "Insert"
      },
      "VpcId": "vpc-bp15zckdt37pq72zv****",
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "ConfigManagedEnabled": false,
      "UpstreamKeepaliveEnabled": false,
      "Ipv6Enabled": false,
      "ServerCount": 1,
      "ServiceName": "test",
      "UchConfig": {
        "Type": "QueryString",
        "Value": "abc"
      },
      "CreateTime": "2022-07-02T02:49:05Z",
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "SlowStartConfig": {
        "SlowStartEnabled": false,
        "SlowStartDuration": 30
      },
      "CrossZoneEnabled": true
    }
  ],
  "TotalCount": 1000
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.