DescribeVServerGroupAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the details of a vServer group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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	READ	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 ID of the request.	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
LoadBalancerId	string	The ID of the CLB instance.	lb-jfakd****
BackendServers	object []	The list of backend servers.
Type	string	The type of the backend server. Valid values: ecs (default): an Elastic Compute Service (ECS) instance eni: an elastic network interface (ENI) eci: an elastic container instance	ecs
Weight	integer	The weight of the backend server.	100
Description	string	The description of the vServer group.	Server Group Description
ServerIp	string	The IP address of the ECS instance, ENI, or elastic container instance.	192.XX.XX.11
Port	integer	The port used by the backend server.	90
ServerId	string	The ID of the ECS instance, ENI, or elastic container instance.	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	object []	The tag list.
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	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

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Added Error Codes: 400