All Products
Search
Document Center

Server Load Balancer:SetVServerGroupAttribute

Last Updated:Mar 14, 2024

Modifies the configurations of a server group.

Operation description

This operation allows you to modify only the name of a vServer group and the weights of the backend servers in the vServer group.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
slb:SetVServerGroupAttributeWRITE
  • loadbalancer
    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Classic Load Balancer (CLB) instance is deployed. This parameter cannot be modified.

cn-hangzhou
VServerGroupIdstringYes

The ID of the vServer group. This parameter cannot be modified.

rsp-cige6****
VServerGroupNamestringNo

The name of the vServer group. You can specify a custom name for the vServer group.

Group1
BackendServersstringNo

The list of backend servers in the vServer group. You can specify at most 20 backend servers for a vServer group in each call.

  • ServerId: required. The ID of the Elastic Compute Service (ECS) instance or elastic network interface (ENI) that serves as a backend server. This parameter must be of the STRING type.

  • Port: required. The port that is used by the backend server. This parameter must be of the INTEGER type. Valid values: 1 to 65535.

  • Weight: required. The weight of the backend server. This parameter must be of the INTEGER type. You can modify this parameter. Valid values: 0 to 100.

  • Description: optional. The description of the backend server. This parameter must be of the STRING type. You can modify this parameter. The description must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.),and underscores (_).

  • Type: the type of backend server. This parameter must be of the STRING type. Valid values:

    • ecs: an ECS instance. This is the default value.
    • eni: an ENI.
  • ServerIp: the IP address of the ECS instance or ENI.

Examples:

  • An ECS instance: [{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port":"80","Description":"test-112" }]
  • An ENI: [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" }]
  • An ENI with multiple IP addresses: [{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168.**.**", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166.**.**", "Port":"80","Description":"test-113" }]
[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.XX.XX.6", "Port":"80","Description":"test-112" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.XX.XX.6", "Port":"80","Description":"test-113" }]

Response parameters

ParameterTypeDescriptionExample
object
VServerGroupIdstring

The ID of the vServer group.

rsp-cige6****
VServerGroupNamestring

The name of the vServer group.

Group1
RequestIdstring

The ID of the request.

9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
BackendServersobject []

The list of backend servers.

Typestring

The type of backend server. Valid values:

  • ecs: an ECS instance
  • eni: an ENI
ecs
Weightinteger

The weight of the backend server.

100
Descriptionstring

The description of the vServer group.

Backend server group description
Portinteger

The port that is used by the backend server.

70
ServerIdstring

The ID of the ECS instance or ENI.

i-bp1ek6yd7jvkx****

Examples

Sample success responses

JSONformat

{
  "VServerGroupId": "rsp-cige6****",
  "VServerGroupName": "Group1",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "BackendServers": {
    "BackendServer": [
      {
        "Type": "ecs",
        "Weight": 100,
        "Description": "Backend server group description",
        "Port": 70,
        "ServerId": "i-bp1ek6yd7jvkx****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400MissingParameterThe VServerGroupName or BackendServers is required at lease one.

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