DescribeVServerGroups - 查詢虛擬伺服器組列表 - Server Load Balancer

查詢虛擬伺服器組列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

slb:DescribeVServerGroups

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	傳統型Server Load Balancer執行個體的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
LoadBalancerId	string	是	傳統型Server Load Balancer執行個體 ID。	lb-bp1o94dp5i6ea*******
IncludeRule	boolean	否	是否返回關聯的轉寄規則資訊。取值： true：是。 false（預設值）：否。	false
IncludeListener	boolean	否	是否返回關聯的監聽資訊。取值： true：是。 false（預設值）：否。	false
Tag	array<object>	否	資源標籤。
	object	否	資源標籤。
Key	string	否	資源的標籤鍵。N 的取值範圍：1~20。一旦輸入該值，則不允許為空白字串。最多支援 64 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	TestKey
Value	string	否	資源的標籤值。N 的取值範圍：1~20。一旦輸入該值，可以為空白字串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	TestValue
Description	string	否	虛擬伺服器組名稱。	Group3

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	9DEC9C28-AB05-4DDF-9A78-6B08******
VServerGroups	object
VServerGroup	array<object>	後端伺服器列表。
	array<object>	後端伺服器列表。
VServerGroupId	string	伺服器組 ID。	rsp-0bf******
VServerGroupName	string	伺服器組名稱。	Group3
AssociatedObjects	object	關聯資訊。
Listeners	object
Listener	array<object>	監聽列表。
	object	監聽列表。
Port	integer	監聽連接埠。	80
Protocol	string	監聽協議。取值：tcp、udp、http 或 https。	tcp
Rules	object
Rule	array<object>	轉寄規則列表。
	object	轉寄規則列表。
Url	string	訪問路徑。	/example
Domain	string	請求網域名稱。	www.example.com
RuleName	string	轉寄規則名稱。	test
RuleId	string	轉寄規則 ID。	rule-a3x3pg1******
ServerCount	integer	伺服器個數。該參數對應的功能預設不開放，如需使用請聯絡我們或提交工單。	1
CreateTime	string	傳統型Server Load Balancer執行個體的建立時間，格式：`YYYY-MM-DDThh:mm:ssZ`。	2022-08-31T02:49:05Z
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
TagKey	string	資源的標籤鍵。	TestKey
TagValue	string	資源的標籤值。	TestValue

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08******",
  "VServerGroups": {
    "VServerGroup": [
      {
        "VServerGroupId": "rsp-0bf******",
        "VServerGroupName": "Group3",
        "AssociatedObjects": {
          "Listeners": {
            "Listener": [
              {
                "Port": 80,
                "Protocol": "tcp"
              }
            ]
          },
          "Rules": {
            "Rule": [
              {
                "Url": "/example",
                "Domain": "www.example.com",
                "RuleName": "test",
                "RuleId": "rule-a3x3pg1******"
              }
            ]
          }
        },
        "ServerCount": 1,
        "CreateTime": "2022-08-31T02:49:05Z",
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParam.TagKey	The param of TagKey is missing.

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

變更歷史

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