Load Balancer
Load Balancer
Document
- Documentation
Load BalancerApplication Load Balancer (ALB)API Referenceserver groupAddServerGroupBackendServers - Adding the backend servers to a specified server group
Copy page
Download PDFserver group
AddServerGroupBackendServers - Adding the backend servers to a specified server group
Copy pageDownload PDFAddServerGroupBackendServers - Adding the backend servers to a specified server group
Call the AddServerGroupBackendServers API to add backend servers to the specified server group.
Instructions
- Each server group can have up to 200 backend servers added.
- Submit up to 5 API requests per second.
Debug
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
The following only details request parameters specific to this API and key common parameters. More information can be found in Common parameters.
Action string required Example: AddServerGroupBackendServers
Action to execute. Set the value to AddServerGroupBackendServers.
Version string required Example: 2020-04-01
The API version. Value: 2020-04-01.
Servers.N.InstanceId string[] required Example: Servers.1.InstanceId=i-3tkuehz8oa3vj0wz****&Servers.2.InstanceId=i-&2feo5qd3orri85oxruvxv****
Backend server.
- Valid values:
- When Servers.N.Type is set to ecs, pass the ID of the ECS instance. You can call the DescribeInstances API to query the ECS instance ID.
- When Servers.N.Type is set to eni, pass the ID of the secondary ENI attached to the ECS. You can call the DescribeNetworkInterfaces API to query the network interface ID.
- When Servers.N.Type is set to ip, pass the IP address as the backend server.
- Parameter - N: Indicates the serial number of the backend server. Value range: 1 to 20.
- Separate multiple backend server IDs with ampersands (&).
Servers.N.Description string[] optional Example: Servers.1.Description=ecs1&Servers.2.Description=ecs2
Backend server description.
- Parameter - N: Indicates the serial number of the backend server. Value range: 1 to 20.
- Must start with a letter or Chinese character and may include numbers, commas (,), periods (.), underscores (_), spaces ( ), equal signs (=), hyphens (-), Chinese commas (，), and Chinese periods (。).
- Must be 1 to 255 characters.
Servers.N.Type string[] required Example: Servers.1.Type=ecs&Servers.2.Type=ecs
Type of backend server.
- Parameter - N: Indicates the serial number of the backend server. Value range: 1-20.
- When the server group is of type "instance", the values are as follows:
- ecs: Elastic Compute Service instance.
- eni: secondary network interface; the primary ENI is not supported.
- When the server group is of type "ip", the value of this parameter is "ip".
Servers.N.Ip string[] required Example: Servers.1.Ip=192.168.1.66&Servers.2.Ip=192.168.1.88
The private IP address of the ECS or secondary ENI.
- Parameter - N: Indicates the serial number of the backend server. Value range: 1-20.
- You can call the DescribeInstances API to query the private IP addresses of backend servers of type "ecs";
- Call the DescribeNetworkInterfaces API to query the private IP addresses of backend servers of type "eni".
Servers.N.RemoteEnabled string[] optional Example: Servers.1.RemoteEnabled=off&Servers.2.RemoteEnabled=off
Enable the remote IP feature.
- When the backend server instance type is IP address (i.e., Type takes the value ip), this field is valid.
- Valid values:
- on: Enable.
- off (default): Do not enable.
Servers.N.Weight integer[] optional Example: Servers.1.Weight=100&Servers.2.Weight=100
Weight of the backend server, with a value range of 0 to 100.
- If the weight is set to 0, no requests will be forwarded to that backend server.
- Parameter - N: Indicates the serial number of the backend server. Value range: 1 to 20.
- If not specified, it defaults to 0.
Servers.N.Port integer[] required Example: Servers.1.Port=88&Servers.2.Port=443
Port number on which the backend server receives requests.
- Value range: 1-65535.
- Parameter - N: Indicates the serial number of the backend server. Value range: 1-20.
ServerGroupId string required Example: rsp-bp1o94dp5i6ea****
Backend server group ID.
Response parameters
Only the response parameters specific to this API are listed below. More information, see Response structure.
RequestId string Example: 20210811152539010225146063030****
Request ID.
ServerIds string[] Example: ["rs-3ciynux6i1x4w****rszh49sj"]
Returns the IDs of the added backend servers.
Request example
GET /?Action=AddServerGroupBackendServers&ServerGroupId=rsp-2ff2u22****ww5oxruwe33hdz&Servers.1.InstanceId=i-3tli51****3vj0wuvaeh&Servers.1.Ip=172.**.**.242&Servers.1.Port=1&Servers.1.Type=ecs&Servers.1.Weight=100&Version=2020-04-01 HTTP/1.1
Host: alb.cn-beijing.volcengineapi.com
X-Date: 20251121T094038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
Response examples
{
"ResponseMetadata": {
"RequestId": "20210816110638****2514606306AF947C",
"Action": "AddServerGroupBackendServers",
"Version": "2020-04-01",
"Service": "alb",
"Region": "cn-beijing"
},
"Result": {
"RequestId": "202108161106****22514606306AF947C",
"ServerIds": [
"rs-3ciynux6i1x4w****rszh49sj"
]
}
}
Error codes
The following table lists the error codes related to the business logic for this API. For details, see Common error codes.
Last updated: 2026.07.31 15:23:26
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
