Query CLB vServer Groups via DescribeVServerGroups with SDK Examples - Classic Load Balancer

Queries vServer groups.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:DescribeVServerGroups

get

*loadbalancer

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

slb:tag
slb:tag
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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9DEC9C28-AB05-4DDF-9A78-6B08******
VServerGroups	object
VServerGroup	array<object>	The backend servers.
	array<object>	Details of the vServer groups.
VServerGroupId	string	The server group ID.	rsp-0bf******
VServerGroupName	string	The server group name.	Group3
AssociatedObjects	object	The associated resources.
Listeners	object
Listener	array<object>	The listeners.
	object	The listener.
Port	integer	The listener port.	80
Protocol	string	The listener protocol. Valid values: tcp, udp, http, and https.	tcp
Rules	object
Rule	array<object>	The forwarding rules.
	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-a3x3pg1******
ServerCount	integer	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	object
Tag	array<object>	The tags.
	object	Tag objects.
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	TestValue

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.