全部產品
Search

搜尋本產品

    Server Load Balancer：ListServerGroups - 查詢服務器組列表

    文件中心

    Server Load Balancer：ListServerGroups - 查詢服務器組列表

    更新時間：Dec 21, 2025

    查詢負載平衡伺服器組列表。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    gwlb:ListServerGroups

    get

    ServerGroup

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

    ServerGroup

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

    VPC

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ServerGroupIds

    array

    否

    伺服器組 ID 列表。

    一次最多支援查詢 20 個伺服器組 ID。

    string

    否

    伺服器組 ID。

    sgp-atstuj3rtoptyui****
    ServerGroupNames

    array

    否

    伺服器組名稱列表。

    一次最多支援查詢 20 個伺服器組名稱。

    string

    否

    伺服器組名稱。

    testServerGroupName
    ServerGroupType

    string

    否

    伺服器群組類型。取值：

    • Instance：伺服器類型，該類型伺服器組支援添加 Ecs、Eni、Eci 類型執行個體。

    • Ip：IP 位址類型，該類型伺服器組支援直接添加 IP 位址類型的後端伺服器。

    Instance
    ResourceGroupId

    string

    否

    資源群組 ID。

    rg-atstuj3rtop****
    Tag

    array<object>

    否

    標籤列表。

    一次調用最多支援 20 個標籤。

    object

    否

    標籤。

    Key

    string

    否

    標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

    testTagKey
    Value

    string

    否

    標籤值。最多支援 256 個字元，不能包含http://或https://。

    testTagValue
    VpcId

    string

    否

    專用網路 ID。

    vpc-bp15zckdt37pq72zv****
    NextToken

    string

    否

    是否擁有下一次查詢的令牌（Token）。取值：

    • 如果 NextToken 為空白表示沒有下一次查詢。

    • 如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    MaxResults

    integer

    否

    分批次查詢時每次顯示的條目數。

    取值範圍：1~1000。

    預設值：20。

    20
    Skip

    integer

    否

    查詢時跳過指定的條目數。

    1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料結構體。

    MaxResults

    integer

    分批次查詢時每次顯示的條目數。

    取值範圍：1~1000。

    20
    NextToken

    string

    是否擁有下一次查詢的令牌（Token）。取值：

    • 如果 NextToken 為空白表示沒有下一次查詢。

    • 如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。

    FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId

    string

    請求 ID。

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

    array<object>

    後端伺服器組列表。

    array<object>

    後端伺服器組。

    ConnectionDrainConfig

    object

    串連優雅中斷相關配置。

    ConnectionDrainEnabled

    boolean

    是否開啟串連優雅中斷。取值：

    • true：開啟。

    • false：關閉。

    false
    ConnectionDrainTimeout

    integer

    串連優雅中斷逾時時間。

    單位：秒。

    取值範圍：1~3600。

    300
    CreateTime

    string

    資源建立時間，使用格林威治時間，格式為yyyy-MM-ddTHH:mm:ssZ。

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

    object

    健全狀態檢查相關配置。

    HealthCheckConnectPort

    integer

    健全狀態檢查使用的後端伺服器的連接埠。

    取值範圍： 1~65535。

    80
    HealthCheckConnectTimeout

    integer

    健全狀態檢查響應的最大逾時時間。

    單位：秒。

    取值範圍：1~300。

    5
    HealthCheckDomain

    string

    用於健全狀態檢查的網域名稱。取值：

    • $SERVER_IP：使用後端伺服器內網 IP。

    • domain：指定特定網域名稱。長度限制 1~80 個字元，只能使用大小寫字母、數字、短劃線（-）、半形句號（.）。

    說明

    僅 HealthCheckProtocol 為 HTTP 時，該參數生效。

    $SERVER_IP
    HealthCheckEnabled

    boolean

    是否開啟健全狀態檢查，取值：

    • true：開啟。

    • false：關閉。

    true
    HealthCheckHttpCode

    array

    健康狀態返回碼列表。

    string

    健康狀態返回碼，多個狀態代碼用半形逗號（,）分隔。 取值：

    • http_2xx

    • http_3xx

    • http_4xx

    • http_5xx

    預設值：http_2xx 。

    說明

    僅 HealthCheckProtocol 為 HTTP 時，該參數生效。

    http_2xx
    HealthCheckInterval

    integer

    健全狀態檢查的時間間隔。

    單位：秒。

    取值範圍：1~50。

    10
    HealthCheckPath

    string

    健全狀態檢查路徑。

    長度為 1~80 個字元，只能使用大小寫英文字母、數字、字元-/.%?#&。 必須以正斜線（/）開頭。

    說明

    僅 HealthCheckProtocol 為 HTTP 時，該參數生效。

    /test/index.html
    HealthCheckProtocol

    string

    健全狀態檢查協議，取值：

    • TCP：通過發送 SYN 握手報文來檢測伺服器連接埠是否存活。

    • HTTP：通過發送 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。

    TCP
    HealthyThreshold

    integer

    健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由失敗判定為成功。

    取值範圍：2~10。

    2
    UnhealthyThreshold

    integer

    健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由成功判定為失敗。

    取值範圍：2~10。

    2
    Protocol

    string

    後端轉寄協議。取值：

    • GENEVE。

    GENEVE
    RelatedLoadBalancerIds

    array

    關聯的Server Load Balancer執行個體 ID 列表。

    string

    關聯的Server Load Balancer執行個體 ID。

    gwlb-cp6prgqy40hols****
    ResourceGroupId

    string

    資源群組 ID。

    rg-atstuj3rtop****
    Scheduler

    string

    調度演算法。取值：

    • 5TCH：五元組雜湊，基於五元組（源 IP、目的 IP、源連接埠、目的連接埠和協議）的一致性雜湊，相同的流會調度到相同的後端伺服器。

    • 3TCH：三元組雜湊，基於三元組（源 IP、目的 IP 和協議）的一致性雜湊，相同的流會調度到相同的後端伺服器。

    • 2TCH：二元組雜湊，基於二元組（源 IP 和目的 IP）的一致性雜湊，相同的流會調度到相同的後端伺服器。

    5TCH
    ServerCount

    integer

    後端伺服器數量。

    2
    ServerGroupId

    string

    伺服器組 ID。

    sgp-atstuj3rtoptyui****
    ServerGroupName

    string

    伺服器組名稱。

    testServerGroupName
    ServerGroupStatus

    string

    伺服器組狀態。取值：

    • Creating：建立中。

    • Available：可用。

    • Configuring：變更配置中。

    Available
    ServerGroupType

    string

    伺服器群組類型。取值：

    • Instance：伺服器類型，該類型伺服器組支援添加 Ecs、Eni、Eci 類型執行個體。

    • Ip：IP 位址類型，該類型伺服器組支援直接添加 IP 位址類型的後端伺服器。

    Instance
    ServerFailoverMode

    string

    伺服器異常時，存量流量的處理方式。取值：

    • NoRebalance：不重新平衡現有流量。

    • Rebalance：重新平衡現有流量。

    NoRebalance
    Tags

    array<object>

    標籤列表。

    object

    標籤。

    Key

    string

    標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 128 個字元，不能以aliyun和acs:開頭，不能包含http://或者https://。

    testTagKey
    Value

    string

    標籤值。最多支援 256 個字元，不能包含http://或https://。

    testTagValue
    VpcId

    string

    專用網路識別碼。

    vpc-bp15zckdt37pq72zv****
    TotalCount

    integer

    列表條目數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "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
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。