DescribeVServerGroups - Server Load Balancer - Alibaba Cloud Documentation Center

Queries vServer groups.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
slb:DescribeVServerGroups	get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Classic Load Balancer (CLB) instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
LoadBalancerId	string	Yes	The ID of the CLB instance.	lb-bp1o94dp5i6ea*******
IncludeRule	boolean	No	Specifies whether to return the forwarding rules associated with the vServer groups. Valid values: true: yes false (default): no	false
IncludeListener	boolean	No	Specifies whether to return information about the associated listeners. Valid values: true: yes false (default): no	false
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The key of tag N. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length, and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs`:.	TestKey
Value	string	No	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag value cannot contain `http://` or `https://`.	TestValue
Description	string	No	The name of the vServer group.	Group3

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
VServerGroups	array<object>	The backend servers.
VServerGroup	object	Details of the vServer groups.
VServerGroupId	string	The server group ID.	rsp-0bfuc*****
VServerGroupName	string	The server group name.	Group3
AssociatedObjects	object	The associated resources.
Listeners	array<object>	The listeners.
Listener	object	The listener.
Port	integer	The listener port.	80
Protocol	string	The listener protocol. Valid values: tcp, udp, http, and https.	tcp
Rules	array<object>	The forwarding rules.
Rule	object	The forwarding rules.
Url	string	The request URL.	/example
Domain	string	The requested domain name.	www.example.com
RuleName	string	The name of the forwarding rule.	test
RuleId	string	The ID of the forwarding rule.	rule-a3x3pg1yohq3lq****
ServerCount	long	The number of servers. This parameter is unavailable by default. To use this parameter, submit a ticket or contact your account manager.	1
CreateTime	string	The time when the CLB instance was created. The time follows the `YYYY-MM-DDThh:mm:ssZ` format.	2022-08-31T02:49:05Z
Tags	array<object>	The tags.
Tag	object	Tag objects.
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	TestValue

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	MissingParam.TagKey	The param of TagKey is missing.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-10-25	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-07-04	The Error code has changed	View Change Details