DescribeVServerGroupAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the detailed information about a vServer group.

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:DescribeVServerGroupAttribute	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.	cn-hangzhou
VServerGroupId	string	Yes	The ID of the vServer group.	rsp-cige6****

Response parameters

Parameter	Type	Description	Example
	object
VServerGroupId	string	The ID of the vServer group.	rsp-cige6****
VServerGroupName	string	The name of the vServer group.	Group1
RequestId	string	The request ID.	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
LoadBalancerId	string	The ID of the CLB instance.	lb-jfakd****
BackendServers	array<object>	The backend servers.
BackendServer	object
Type	string	The type of backend server. Valid values: ecs: ECS instance eni: ENI eci: elastic container instance	ecs
Weight	integer	The weight of the backend server.	100
Description	string	The description of the server group. Note This parameter is not returned if the Description parameter is not specified in the request.	Server Group Description
ServerIp	string	The IP address of the backend server.	192.XX.XX.11
Port	integer	The port that is used by the backend server.	90
ServerId	string	The ID of the backend server.	vm-233
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 of the backend server.
Tag	object	The tags.
TagKey	string	The tag key. 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
TagValue	string	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 contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.	TestValue

Examples

Sample success responses

JSONformat

{
  "VServerGroupId": "rsp-cige6****",
  "VServerGroupName": "Group1",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "LoadBalancerId": "lb-jfakd****",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 100,
        "Description": "Server Group Description",
        "ServerIp": "192.XX.XX.11",
        "Port": 90,
        "ServerId": "vm-233"
      }
    ]
  },
  "CreateTime": "2022-08-31T02:49:05Z",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	LocationServiceTimeout	Location service connection timeout. Please try again later.

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

Change history

Change time	Summary of changes	Operation
2023-09-08	The Error code has changed	View Change Details