Queries the vServer groups of a Classic Load Balancer (CLB) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVServerGroups

The operation that you want to perform. Set the value to DescribeVServerGroups.

RegionId String Yes cn-hangzhou

The ID of the region where the CLB instance is deployed.

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

The ID of the CLB instance.

IncludeRule Boolean No false

Specifies whether to return the forwarding rules associated with the vServer groups. Valid values:

  • true: yes
  • false (default): no
IncludeListener Boolean No false

Specifies whether to return the listeners associated with the vServer groups. Valid values:

  • true: yes
  • false (default): no

Response parameters

Parameter Type Example Description
RequestId String 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

The ID of the request.

VServerGroups Array of VServerGroup

The list of backend servers.

VServerGroup
VServerGroupId String rsp-0bfucw****

The ID of the vServer group.

VServerGroupName String Group3

The name of the server group.

AssociatedObjects Object

The items associated with the server groups.

Listeners Array of Listener

The list of listeners.

Listener
Port Integer 80

The listening port.

Protocol String tcp

The listening protocol.

Rules Array of Rule

The list of forwarding rules.

Rule
Url String /example

The path.

Domain String www.example.com

The requested domain name.

RuleName String test

The name of the forwarding rule.

RuleId String rule-9rwgz3****

The ID of the forwarding rule.

ServerCount Long 6

The number of backend servers in the specified server group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVServerGroups
&ResourceOwnerId=111
&RegionId=cn-hangzhou
&LoadBalancerId=lb-bp1o94dp5i6ea*******
&IncludeRule=false
&IncludeListener=false
&Common request parameters

Sample success responses

XML format 

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 format 

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
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.