全部产品
Search

搜索本产品

    Server Load Balancer：ListServerGroups

    文档中心

    Server Load Balancer：ListServerGroups

    更新时间：Dec 21, 2025

    Mengambil daftar grup server dari 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:ListServerGroups

    get

    ServerGroup

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

    ServerGroup

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

    VPC

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ServerGroupIds

    array

    No

    ID grup server.

    Anda dapat menentukan paling banyak 20 ID grup server dalam setiap panggilan.

    string

    No

    ID grup server.

    sgp-atstuj3rtoptyui****
    ServerGroupNames

    array

    No

    Nama grup server.

    Anda dapat menentukan paling banyak 20 nama grup server dalam setiap panggilan.

    string

    No

    Nama grup server.

    testServerGroupName
    ServerGroupType

    string

    No

    Tipe grup server. Nilai yang valid:

    • Instance: memungkinkan Anda menentukan resource bertipe Ecs, Eni, atau Eci.

    • Ip: memungkinkan Anda menambahkan server dengan menentukan alamat IP.

    Instance
    ResourceGroupId

    string

    No

    ID kelompok sumber daya tempat instans tersebut berada.

    rg-atstuj3rtop****
    Tag

    array<object>

    No

    Kunci tag.

    Anda dapat menentukan paling banyak 20 tag dalam setiap panggilan.

    object

    No

    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 acs: atau aliyun. 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
    VpcId

    string

    No

    ID VPC.

    vpc-bp15zckdt37pq72zv****
    NextToken

    string

    No

    Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid:

    • Jika NextToken kosong, berarti tidak ada halaman berikutnya.

    • Jika nilai NextToken dikembalikan, nilai tersebut menunjukkan token yang digunakan untuk kueri berikutnya.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    MaxResults

    integer

    No

    Jumlah entri per halaman.

    Nilai yang valid: 1 hingga 1000.

    Nilai default: 20.

    20
    Skip

    integer

    No

    Jumlah entri yang dilewati dalam panggilan ini.

    1

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    MaxResults

    integer

    Jumlah entri per halaman.

    Nilai yang valid: 1 hingga 1000.

    20
    NextToken

    string

    Token paginasi. Token ini dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Nilai yang valid:

    • Jika NextToken kosong, berarti tidak ada halaman berikutnya.

    • Jika nilai NextToken dikembalikan, nilai tersebut menunjukkan token yang digunakan untuk kueri berikutnya.

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId

    string

    ID permintaan.

    54B48E3D-DF70-471B-AA93-08E683A1B45
    ServerGroups

    array<object>

    Konfigurasi grup server.

    array<object>

    Grup server.

    ConnectionDrainConfig

    object

    Konfigurasi Pengurasan koneksi.

    ConnectionDrainEnabled

    boolean

    Menunjukkan apakah Pengurasan koneksi diaktifkan. Nilai yang valid:

    • true

    • false

    false
    ConnectionDrainTimeout

    integer

    Periode timeout Pengurasan koneksi.

    Unit: detik

    Nilai yang valid: 1 hingga 3600.

    300
    CreateTime

    string

    Waktu saat resource dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    2024-08-05T18:24:07Z
    HealthCheckConfig

    object

    Konfigurasi Pemeriksaan kesehatan.

    HealthCheckConnectPort

    integer

    Port server backend yang digunakan untuk Pemeriksaan kesehatan.

    Nilai yang valid: 1 hingga 65535.

    80
    HealthCheckConnectTimeout

    integer

    Periode timeout maksimum untuk 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 internal server backend.

    • domain: nama domain. Nama domain harus terdiri dari 1 hingga 80 karakter, dan dapat berisi huruf, angka, tanda hubung (-), serta titik (.).

    Catatan

    Parameter ini hanya berlaku jika Anda mengatur HealthCheckProtocol ke HTTP.

    $SERVER_IP
    HealthCheckEnabled

    boolean

    Menunjukkan apakah fitur Pemeriksaan kesehatan diaktifkan. Nilai yang valid:

    • true

    • false

    true
    HealthCheckHttpCode

    array

    Kode status HTTP yang dikembalikan sistem untuk Pemeriksaan kesehatan.

    string

    Kode status HTTP yang dikembalikan untuk Pemeriksaan kesehatan. Pisahkan beberapa kode status HTTP dengan koma (,). Nilai yang valid:

    • http_2xx

    • http_3xx

    • http_4xx

    • http_5xx

    Nilai default: http_2xx.

    Catatan

    Parameter ini hanya berlaku jika Anda mengatur HealthCheckProtocol ke HTTP.

    http_2xx
    HealthCheckInterval

    integer

    Interval pelaksanaan Pemeriksaan kesehatan.

    Unit: detik

    Nilai yang valid: 1 hingga 50.

    10
    HealthCheckPath

    string

    URL yang digunakan untuk Pemeriksaan kesehatan.

    Panjang URL harus antara 1 hingga 80 karakter, dan dapat berisi huruf, angka, serta karakter khusus berikut: - / . % ? # & URL harus diawali dengan garis miring (/).

    Catatan

    Parameter ini hanya berlaku jika Anda mengatur HealthCheckProtocol ke HTTP.

    /test/index.html
    HealthCheckProtocol

    string

    Protokol yang digunakan untuk Pemeriksaan kesehatan. Nilai yang valid:

    • TCP: Pemeriksaan kesehatan TCP mengirim paket TCP SYN ke server backend untuk memeriksa apakah port server backend dapat dijangkau.

    • HTTP: Pemeriksaan kesehatan HTTP mensimulasikan proses akses sumber daya menggunakan browser web dengan mengirim permintaan HEAD atau GET ke instans. Permintaan ini digunakan untuk memeriksa apakah instans dalam kondisi sehat.

    TCP
    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.

    Nilai yang valid: 2 hingga 10.

    2
    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.

    Nilai yang valid: 2 hingga 10.

    2
    Protocol

    string

    Protokol backend. Nilai yang valid:

    • GENEVE.

    GENEVE
    RelatedLoadBalancerIds

    array

    ID instans GWLB yang terkait dengan grup server.

    string

    ID instans GWLB yang terkait dengan grup server.

    gwlb-cp6prgqy40hols****
    ResourceGroupId

    string

    ID kelompok sumber daya.

    rg-atstuj3rtop****
    Scheduler

    string

    Algoritma penjadwalan. Nilai yang valid:

    • 5TCH: menunjukkan penghashan konsisten berdasarkan faktor-faktor berikut: alamat IP sumber, alamat IP tujuan, port sumber, protokol, dan port tujuan. Permintaan yang memiliki informasi yang sama berdasarkan faktor-faktor tersebut akan diteruskan ke server backend yang sama.

    • 3TCH: menunjukkan penghashan konsisten berdasarkan faktor-faktor berikut: alamat IP sumber, alamat IP tujuan, dan protokol. Permintaan yang memiliki informasi yang sama berdasarkan faktor-faktor tersebut akan diteruskan ke server backend yang sama.

    • 2TCH: menunjukkan penghashan konsisten berdasarkan faktor-faktor berikut: alamat IP sumber dan alamat IP tujuan. Permintaan yang memiliki informasi yang sama berdasarkan faktor-faktor tersebut akan diteruskan ke server backend yang sama.

    5TCH
    ServerCount

    integer

    Jumlah grup server.

    2
    ServerGroupId

    string

    ID grup server.

    sgp-atstuj3rtoptyui****
    ServerGroupName

    string

    Nama grup server.

    testServerGroupName
    ServerGroupStatus

    string

    Status grup server. Nilai yang valid:

    • Creating

    • Available

    • Configuring

    Available
    ServerGroupType

    string

    Tipe grup server. Nilai yang valid:

    • Instance: memungkinkan Anda menentukan server bertipe Ecs, Eni, atau Eci.

    • Ip: memungkinkan Anda menambahkan server dengan menentukan alamat IP.

    Instance
    ServerFailoverMode

    string

    Menentukan cara GWLB memproses permintaan melalui koneksi yang sudah ada ketika server backend tidak berjalan sebagaimana mestinya. Nilai yang valid:

    • NoRebalance: GWLB tetap meneruskan permintaan melalui koneksi yang sudah ada ke server backend yang tidak sehat.

    • Rebalance: GWLB meneruskan permintaan melalui koneksi yang sudah ada ke server backend yang masih sehat.

    NoRebalance
    Tags

    array<object>

    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 acs: atau aliyun. Kunci tag tidak boleh mengandung http:// atau https://.

    testTagKey
    Value

    string

    Nilai tag. Panjang nilai tag dapat mencapai 256 karakter dan tidak boleh mengandung http:// atau https://.

    testTagValue
    VpcId

    string

    ID 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
      },
      "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.