SetVServerGroupAttribute - Server Load Balancer - Alibaba Cloud Documentation Center

Modifies the configurations of a vServer group.

Operation description

This operation can be used to modify the weights of backend servers and names of vServer groups.

If you want to modify backend servers in a specified vServer group, call the ModifyVServerGroupBackendServers operation.
If you want to add backend servers to a specified vServer group, call the AddVServerGroupBackendServers operation.

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:SetVServerGroupAttribute	update	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 Server Load Balancer (SLB) instance, which cannot be modified.	cn-hangzhou
VServerGroupId	string	Yes	The vServer group ID, which cannot be modified.	rsp-cige6****
VServerGroupName	string	No	The vServer group name. You can specify a name.	Group1
BackendServers	string	No	The backend servers. This operation only can be used to modify the weights of backend servers and names of vServer groups. Configure the following parameters: ServerId: Required. The ID of the backend server. Specify the value in a string. You can specify the ID of an Elastic Compute Service (ECS) instance, an elastic network interface (ENI), or an elastic container instance. If you set ServerId to the ID of an ENI or an elastic container instance, you must configure the Type parameter. Weight: the weight of the backend server. Valid values: 0 to 100. Default value: 100. If you set the weight of a backend server to 0, no requests are forwarded to the backend server. Description: Optional. The description of the backend server. Specify the value in a string. 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 the backend server. Valid values: ecs (default): ECS instance eni: ENI eci: elastic container instance Note You can specify ENIs and elastic container instances as backend servers only for high-performance CLB instances. ServerIp: the IP address of an ENI or an elastic container instance. Port: the backend port. Examples: Add ECS instances: `[{ "ServerId": "i-xxxxxxxxx", "Weight": "100", "Type": "ecs", "Port":"80","Description":"test-112" }]` Add ENIs: `[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168..", "Port":"80","Description":"test-112" }]` Add ENIs with multiple IP addresses: `[{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "192.168..", "Port":"80","Description":"test-113" },{ "ServerId": "eni-xxxxxxxxx", "Weight": "100", "Type": "eni", "ServerIp": "172.166..", "Port":"80","Description":"test-113" }]` Add elastic container instances: `[{ "ServerId": "eci-xxxxxxxxx", "Weight": "100", "Type": "eci", "ServerIp": "192.168..", "Port":"80","Description":"test-114" }]` Note You can add only running backend servers to SLB instances. You can specify at most 20 backend servers in each call.	[{ "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

Parameter	Type	Description	Example
	object
VServerGroupId	string	The server group ID.	rsp-cige6****
VServerGroupName	string	The name of the vServer group.	Group1
RequestId	string	The request ID.	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
BackendServers	array<object>	The backend servers.
BackendServer	object
Type	string	The type of backend server. Valid values: ecs (default): 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.	Backend server group description
Port	integer	The port that is used by the backend server.	70
ServerId	string	The ID of the backend server.	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 code	Error code	Error message
400	MissingParameter	The VServerGroupName or BackendServers is required at lease one.
400	InvalidParameter.ZoneNotSupport	The zone does not support the parameter %s.

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