调用DescribeVServerGroups查询服务器组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVServerGroups

系统规定参数。取值:DescribeVServerGroups

RegionId String cn-hangzhou

负载均衡实例的地域ID。

LoadBalancerId String lb-bp1o94dp5i6ea*******

负载均衡实例ID。

IncludeRule Boolean false

返回关联的转发规则信息。取值:

  • true:返回。
  • false(默认值):不返回。
IncludeListener Boolean false

返回关联的监听信息。取值:

  • true:返回。
  • false(默认值):不返回。

返回数据

名称 类型 示例值 描述
RequestId String 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

请求ID。

VServerGroups Array of VServerGroup

后端服务器列表。

VServerGroup
VServerGroupId String rsp-0bfucw****

服务器组ID。

VServerGroupName String Group3

服务器组名称。

AssociatedObjects Object

关联信息。

Listeners Array of Listener

监听列表。

Listener
Port Integer 80

监听端口。

Protocol String tcp

监听协议。

Rules Array of Rule

转发规则列表。

Rule
Url String /example

访问路径。

Domain String www.example.com

请求域名。

RuleName String test

转发规则名称。

RuleId String rule-9rwgz3****

转发规则ID。

ServerCount Long 6

指定服务器组中包含的后端服务器的数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVServerGroups
&ResourceOwnerId=111
&RegionId=cn-hangzhou
&LoadBalancerId=lb-bp1o94dp5i6ea*******
&IncludeRule=false
&IncludeListener=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVServerGroupsResponse>
    <RequestId>9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C</RequestId>
    <VServerGroups>
        <VServerGroupId>rsp-0bfucw****</VServerGroupId>
        <VServerGroupName>Group3</VServerGroupName>
        <AssociatedObjects>
            <Listeners>
                <Port>80</Port>
                <Protocol>tcp</Protocol>
            </Listeners>
            <Rules>
                <Url>/example</Url>
                <Domain>www.example.com</Domain>
                <RuleName>test</RuleName>
                <RuleId>rule-9rwgz3****</RuleId>
            </Rules>
        </AssociatedObjects>
        <ServerCount>6</ServerCount>
    </VServerGroups>
</DescribeVServerGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "VServerGroups" : [ {
    "VServerGroupId" : "rsp-0bfucw****",
    "VServerGroupName" : "Group3",
    "AssociatedObjects" : {
      "Listeners" : [ {
        "Port" : 80,
        "Protocol" : "tcp"
      } ],
      "Rules" : [ {
        "Url" : "/example",
        "Domain" : "www.example.com",
        "RuleName" : "test",
        "RuleId" : "rule-9rwgz3****"
      } ]
    },
    "ServerCount" : 6
  } ]
}

错误码

访问错误中心查看更多错误码。