DescribeVServerGroupAttribute API Reference & Parameters - Classic Load Balancer

Queries the detailed information about a vServer group.

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:DescribeVServerGroupAttribute

get

*loadbalancer

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

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

Response elements

Element	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-6B******
LoadBalancerId	string	The ID of the CLB instance.	lb-jfakd****
BackendServers	object
BackendServer	array<object>	The backend servers.
	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.	The description of the server group.
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	object
Tag	array<object>	The tags of the backend server.
	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

Success response

JSON format

{
  "VServerGroupId": "rsp-cige6****",
  "VServerGroupName": "Group1",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B******",
  "LoadBalancerId": "lb-jfakd****",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 100,
        "Description": "The description of the server group.",
        "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	Description
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	The specified region of is not authorized.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.