ListServerGroups - 查詢服務器組 - Server Load Balancer

查詢服務器組列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

alb:ListServerGroups

get

*ServerGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
ServerGroupIds	array	否	伺服器組 ID 列表。
	string	否	伺服器組 ID，一次最多支援查詢 20 個伺服器組 ID。	sgp-atstuj3rtop****
ServerGroupNames	array	否	伺服器組名稱列表，最多 10 個。
	string	否	伺服器組名稱，一次最多支援查詢 10 個伺服器組名稱。	Group3
ResourceGroupId	string	否	資源群組 ID。	rg-atstuj3rtop****
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	否	分批次查詢時每次顯示的條目數。取值範圍：1~100，預設值為 20。	20
VpcId	string	否	VPC 執行個體 ID。	vpc-bp15zckdt37pq72zv****
ServerGroupType	string	否	伺服器群組類型。取值： Instance：伺服器類型，包括 Ecs、Eni、Eci 執行個體。 Ip：IP 位址類型。 Fc：Function Compute類型。不填則查詢所有類型。	Instance
Tag	array<object>	否	伺服器組綁定的標籤列表。一次請求中，綁定的標籤列表中最多支援 10 個標籤。	Instance
	object	否	伺服器組綁定的標籤，單次支援傳入 10 個標籤。
Key	string	否	標籤鍵。最多支援 10 個標籤鍵。最多支援 64 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	Test
Value	string	否	標籤值。最多支援 10 個標籤值。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	Test

返回參數

名稱	類型	描述	樣本值
	object	返回資料結構體。
MaxResults	integer	分批次查詢時每次顯示的條目數。	50
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	caeba0bbb2be03f8****
RequestId	string	請求 ID。	CEF72CEB-54B6-4AE8-B225-F876******
ServerGroups	array<object>	後端伺服器組列表。
	array<object>	後端伺服器組列表。
HealthCheckConfig	object	健全狀態檢查配置。
HealthCheckConnectPort	integer	健全狀態檢查的後端伺服器的連接埠。取值範圍：0~65535。返回為 0 時代表使用後端伺服器的連接埠進行健全狀態檢查。	80
HealthCheckEnabled	boolean	是否啟用健全狀態檢查，取值： true：啟用。 false：不啟用。	true
HealthCheckHost	string	健全狀態檢查網域名稱。使用後端伺服器的內網 IP（預設）：使用後端伺服器的內網 IP 位址作為健全狀態檢查的網域名稱。指定特定網域名稱：輸入一個網域名稱。長度限制為 1~80 個字元。可包含小寫字母、數字、短劃線（-）和半形句號（.）。至少包含一個半形句號（.），半形句號（.）不能出現在開頭或結尾。最右側的域標籤，只能包含字母，不能包含數字或短劃線（-）。短劃線（-）不能出現在開頭或結尾。說明只有 HealthCheckProtocol 設定為 HTTP、HTTPS 或 gRPC 時，該參數生效。	www.example.com
HealthCheckCodes	array	健全狀態檢查正常的狀態代碼列表。
	string	健全狀態檢查正常的狀態代碼。當 HealthCheckProtocol 取值為 HTTP 或 HTTPS 時，HealthCheckCodes 可以選擇http_2xx、 http_3xx、http_4xx和http_5xx。多個狀態代碼用半形逗號（,）分隔。當 HealthCheckProtocol 取值為 gRPC 時，HealthCheckCodes 狀態代碼範圍：0~99。支援範圍輸入，最多支援 20 個範圍值，多個範圍值使用半形逗號（,）隔開。說明 HealthCheckProtocol 為 HTTP 或 HTTPS 或 gRPC 時，該參數生效。	http_2xx
HealthCheckHttpVersion	string	健全狀態檢查 HTTP 協議版本。取值：HTTP1.0或HTTP1.1。說明只有 HealthCheckProtocol 設定為 HTTP 或 HTTPS 時，該參數生效。	HTTP1.1
HealthCheckInterval	integer	健全狀態檢查的時間間隔。單位：秒。取值範圍：1~50。	5
HealthCheckMethod	string	健全狀態檢查方法。取值： GET：如果響應報文長度超過 8K，會被截斷，但不會影響健全狀態檢查結果的判定。 POST：gRPC 監聽健全狀態檢查預設採用 POST 方法。 HEAD：HTTP 和 HTTPS 監聽健全狀態檢查預設採用 HEAD 方法。說明只有 HealthCheckProtocol 設定為 HTTP 或 HTTPS 或 gRPC 時，該參數生效。	HEAD
HealthCheckPath	string	健全狀態檢查的轉寄規則路徑。說明只有 HealthCheckProtocol 設定為 HTTP 或 HTTPS 時，該參數生效。	/test/index.html
HealthCheckProtocol	string	健全狀態檢查協議。取值： HTTP：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。 HTTPS：通過發送 HEAD 或 GET 請求類比瀏覽器的訪問行為來檢查伺服器應用是否健康。（資料加密，相比 HTTP 更安全。） TCP：通過發送 SYN 握手報文來檢測伺服器連接埠是否存活。 gRPC：通過發送 POST 或 GET 請求來檢查伺服器應用是否健康。	HTTP
HealthCheckTimeout	integer	接收來自健全狀態檢查的響應需要等待的時間。如果後端伺服器在指定的時間內沒有正確響應，則判定為健全狀態檢查失敗。單位：秒。	3
HealthyThreshold	integer	健全狀態檢查連續成功多少次後，將後端伺服器的健全狀態檢查狀態由失敗判定為成功。	4
UnhealthyThreshold	integer	健全狀態檢查連續失敗多少次後，將後端伺服器的健全狀態檢查狀態由成功判定為失敗。	4
Protocol	string	後端協議類型。取值： HTTP：支援關聯 HTTPS、HTTP 和 QUIC 監聽。 HTTPS：支援關聯 HTTPS 監聽。 GRPC：關聯 HTTPS 和 QUIC 監聽。	HTTP
RelatedLoadBalancerIds	array	關聯的執行個體 id
	string	關聯的Server Load Balancer執行個體 id	alb-n5qw04uq8savfe****
ResourceGroupId	string	資源群組 ID。	rg-atstuj3rtop****
Scheduler	string	調度演算法。取值： Wrr：加權輪詢，權重值越高的後端伺服器，被輪詢到的機率也越高。 Wlc：加權最小串連數，除了根據每台後端伺服器設定的權重值來進行輪詢，同時還考慮後端伺服器的實際負載（即串連數）。當權重值相同時，當前串連數越小的後端伺服器被輪詢到的機率也越高。 Sch：一致性雜湊，相同雜湊因子計算結果的請求將會調度到相同的後端伺服器。不配置 UchConfig 參數時，預設雜湊因子為源 IP，相同源 IP 位址的請求會分發到同一台後端伺服器；配置了 UchConfig 參數時，雜湊因子為 URL 參數，相同 URL 參數的請求會分發到同一台後端伺服器。	Wrr
ServerGroupId	string	伺服器組 ID。	sgp-cige6j****
ServerGroupName	string	伺服器組名稱。	Group3
ServerGroupStatus	string	伺服器組狀態。取值： Creating：建立中。 Available：可用。 Configuring：變更配置中。	Available
ServerGroupType	string	伺服器群組類型。取值： Instance：伺服器類型，包括 Ecs、Eni、Eci 執行個體。 Ip：IP 類型。 Fc：Function Compute類型。	Instance
StickySessionConfig	object	會話保持配置結構體。
Cookie	string	伺服器上配置的 Cookie。	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	Cookie 逾時時間。單位：秒。取值範圍：1~86400。說明當 StickySessionEnabled 為 true 且 StickySessionType 為 Insert 時，該參數生效。	1000
StickySessionEnabled	boolean	是否啟用會話保持。取值： true：開啟。 false：關閉。	false
StickySessionType	string	Cookie 的處理方式。取值： Insert：植入 Cookie。用戶端第一次訪問時，負載平衡會在返回請求中植入 Cookie（即在 HTTP 或 HTTPS 響應報文中插入 SERVERID），下次用戶端攜帶此 Cookie 訪問，負載平衡服務會將請求定向轉寄給之前記錄到的後端伺服器上。 Server：重寫 Cookie。負載平衡發現使用者自訂了 Cookie，將會對原來的 Cookie 進行重寫，下次用戶端攜帶新的 Cookie 訪問，負載平衡服務會將請求定向轉寄給之前記錄到的後端伺服器。	Insert
VpcId	string	VPC 執行個體 ID。	vpc-bp15zckdt37pq72zv****
Tags	array<object>	伺服器組綁定的標籤列表。
	object	伺服器組綁定的標籤列表。
Key	string	標籤鍵。	Test
Value	string	標籤值。	Test
ConfigManagedEnabled	boolean	是否開啟組態管理。取值： true：開啟。 false：關閉。	false
UpstreamKeepaliveEnabled	boolean	是否開啟後端長連結。取值： true：開啟。 false：關閉。	false
Ipv6Enabled	boolean	是否支援 IPv6。取值： true：支援。 false：不支援。	false
ServerCount	integer	伺服器組內伺服器數量。	1
ServiceName	string	服務名稱。	test
UchConfig	object	url 一致性 hash 參數配置。
Type	string	參數類型。只能填 QueryString。	QueryString
Value	string	一致性 hash 參數值。	abc
CreateTime	string	資源建立時間。	2022-07-02T02:49:05Z
ConnectionDrainConfig	object	串連優雅中斷相關配置。開啟串連優雅中斷，在移除後端伺服器或者健全狀態檢查失敗後，負載平衡使現有串連在一定時間內正常傳輸。說明基礎版執行個體不支援開啟串連優雅中斷，僅標準版、WAF 增強版執行個體支援。伺服器類型、IP 類型伺服器組支援串連優雅中斷，Function Compute類型不支援。
ConnectionDrainEnabled	boolean	是否開啟串連優雅中斷。 true：開啟 false：關閉	false
ConnectionDrainTimeout	integer	串連優雅中斷逾時時間。	300
SlowStartConfig	object	慢啟動相關配置。開啟慢啟動後，將會在設定的時間段內對新添加到後端伺服器組的後端伺服器進行預熱，轉寄到該伺服器的請求數量線性增加。說明基礎版執行個體不支援開啟慢啟動，僅標準版、WAF 增強版執行個體支援。伺服器類型、IP 類型伺服器組支援配置慢啟動，Function Compute類型不支援。慢啟動僅在後端調度演算法是加權輪詢演算法時可開啟。
SlowStartEnabled	boolean	是否開啟慢啟動。 true：開啟 false：關閉	false
SlowStartDuration	integer	慢啟動期間。	30
CrossZoneEnabled	boolean	伺服器組是否開啟跨 AZ 負載平衡。取值： true：開啟（預設值） false：關閉	true
TotalCount	integer	列表條目數。	1000

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

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