Queries detailed information about a vServer group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVServerGroupAttribute

The operation that you want to perform.

Set the value to DescribeVServerGroupAttribute.

RegionId String Yes cn-hangzhou

The ID of the region where the Classic Load Balancer (CLB) instance is deployed.

VServerGroupId String Yes rsp-cige6****

The ID of the vServer group.

Response parameters

Parameter Type Example Description
VServerGroupId String rsp-cige6****

The ID of the vServer group.

VServerGroupName String Group1

The name of the vServer group.

BackendServers Array of BackendServer N/A

The list of backend servers.

BackendServer N/A N/A N/A
ServerId String vm-233

The ID of the Elastic Compute Service (ECS) instance.

Port Integer 90

The port that is used by the backend server.

Weight Integer 100

The weight of the backend server.

Description String vServerGroupDescription

The description of the vServer group.

Type String ecs

The type of backend server. Valid values:

  • ecs: an ECS instance. This is the default value.
  • eni: an elastic network interface (ENI).
LoadBalancerId String lb-jfakd****

The ID of the CLB instance.

RequestId String 9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVServerGroupAttribute
&RegionId=cn-hangzhou
&VServerGroupId=rsp-cige6****
&<Common request parameters>

Sample success responses

XML format 

<DescribeVServerGroupAttributeResponse>
      <RequestId>9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C</RequestId>
      <VServerGroupId>rsp-cige6******</VServerGroupId>
      <VServerGroupName>Group1</VServerGroupName>
      <BackendServers>
            <BackendServer>
                  <ServerId>vm-232</ServerId>
                  <Port>80</Port>
                  <Weight>100</Weight>
            </BackendServer>
            <BackendServer>
                  <ServerId>vm-233</ServerId>
                  <Port>90</Port>
                  <Weight>100</Weight>
            </BackendServer>
      </BackendServers>
</DescribeVServerGroupAttributeResponse>

JSON format 

{
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "VServerGroupId": "rsp-cige6******",
  "VServerGroupName": "Group1",
  "BackendServers": {
    "BackendServer": [
      {
        "ServerId": "vm-233",
        "Port": "80",
        "Weight": "100"
      },
      {
        "ServerId": "vm-232",
        "Port": "90",
        "Weight": "100"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the API Error Center.