Queries the list of VServer groups.

Debug

We recommend that you use OpenAPI Explorer to call APIs, generate SDK code examples, perform debug operations, and search for APIs.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribeVServerGroups

The name of this action. Value: DescribeVServerGroups

LoadBalancerId String Yes lb-bp1o94dp5i6earr9g6d1l

The ID of the SLB instance.

RegionId String Yes cn-hangzhou

The region ID of the SLB instance.

IncludeListener Boolean No false

Optional. The associated listener information is returned. Default value: false

IncludeRule Boolean No false

Optional. The associated forwarding rule information is returned. Default value: false

Response parameters

Parameter Type Example value Description
VServerGroups N/A N/A

A list of backend servers.

  └VServerGroupId String rsp-0bfucwuotx

The ID of the VServer group.

  └VServerGroupName String Group3

The name of the VServer group.

  └AssociatedObjects N/A N/A

Associated information.

    └Listeners N/A N/A

A list of associated listeners.

      └Port Integer 80

The listening port.

      └Protocol String tcp

The protocol used by the listener.

    └Rules N/A N/A

A list of forwarding rules.

      └Domain String www.example.com

The request domain name.

      └RuleId String 123

The ID of the forwarding rule.

      └RuleName String test

The name of the forwarding rule.

      └Url String /example

The access path.

RequestId String 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

The ID of the request.

Examples

Request example


/? Action=DescribeVServerGroups
&LoadBalancerId=152a602e315-cn-hangzhou-a01
&RegionId=cn-hangzhou
&<CommonParameters>

Response examples

XML format

<DescribeVServerGroups>
  <VServerGroups>
    <VServerGroup>
      <VServerGroupId>rsp-bp12bjrnykyp0</VServerGroupId>
      <VServerGroupName>6</VServerGroupName>
      <AssociatedObjects>
        <Listeners/>
        <Rules/>
      </AssociatedObjects>
    </VServerGroup>
    <VServerGroup>
      <VServerGroupId>rsp-bp16rt0dzbm23</VServerGroupId>
      <VServerGroupName>text2</VServerGroupName>
      <AssociatedObjects>
        <Listeners/>
        <Rules/>
      </AssociatedObjects>
    </VServerGroup>
  </VServerGroups>
  <RequestId>E3F94C66-5DDD-4A6B-B37D-FD237FB31FE6</RequestId>
</DescribeVServerGroups>

JSON format

{
	"VServerGroups":[
		{
			"VServerGroupId":"rsp-cige6j5e7p",
			"VServerGroupName":"Group1"
		},
		{
			"VServerGroupId":"rsp-6cejjzlld7",
			"VServerGroupName":"Group2"
		},
		{
			"VServerGroupId":"rsp-0bfucwuotx",
			"VServerGroupName":"Group3"
		}
	],
	"RequestId":"9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C"
}

Error codes

See common error codes.