Adding a Backend Server
Function
This API is used to add a backend server.
Constraints
When you add backend servers, note the following:
-
Two backend servers in the same backend server group must have different IP addresses and ports.
-
If no subnets are specified during cloud server creation, IP as backend servers can be added. In this case, address must be set to an IPv4 address, the protocol of the backend server group must be TCP, HTTP, or HTTPS, and IP as a Backend must have been enabled for the load balancer.
-
If a subnet is specified during cloud server creation, the subnet must be in the same VPC where the load balancer resides.
-
If the backend server group supports IPv4/IPv6 dual stack, address can be an IPv4 address or an IPv6 address. If the backend server group supports only IPv4, address can only be an IPv4 address.
-
If type of the backend server is set to instance, address must be a private IP address that is not used by any load balancer.
-
If the backend server group protocol is IP, protocol_port of the backend server must be 0 and IP as backend servers cannot be added.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/elb/pools/{pool_id}/members
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pool_id |
Yes |
String |
Definition: Specifies the backend server group ID. |
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
member |
Yes |
CreateMemberOption object |
Definition: Specifies the backend server. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
address |
Yes |
String |
Definition: Specifies the IP address of the backend server. Constraints:
|
admin_state_up |
No |
Boolean |
Definition: Specifies the administrative status of the backend server. Constraints: Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether ECSs exist. If ECSs exist, the value is true. Otherwise, the value is false. Range: true or false |
name |
No |
String |
Definition: Specifies the backend server name. Note: The name is not an ECS name. If this parameter is not specified, an empty value will be returned. |
project_id |
No |
String |
Definition: Specifies the project ID of the backend server. |
protocol_port |
No |
Integer |
Definition: Specifies the port used by the backend server to receive requests. Constraints:
|
subnet_cidr_id |
No |
String |
Definition: Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides. neutron_subnet_id defines IPv4 subnets, and neutron_network_id defines IPv6 subnets. You can query parameter neutron_subnet_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets) to get the IPv4 subnet ID. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets) to get the IPv6 subnet ID. Constraints:
|
weight |
No |
Integer |
Definition: Specifies the weight of the backend server. Requests are routed based on the load balancing algorithm configured for the backend server group and weights of backend servers. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests. Constraints: If lb_algorithm is set to SOURCE_IP or QUIC_CID, this parameter will not take effect. Range: 0 to 100. The default value is 1. |
availability_zone |
No |
String |
Definition: Specifies the AZ of the backend server. Constraints:
Range: AZs available for ECSs in the current region. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
member |
Member object |
Definition: Specifies the backend server. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the backend server ID.
NOTE:
The value of this parameter is not the ID of the server but an ID automatically generated for the backend server that is associated with the load balancer.
|
availability_zone |
String |
Definition: Specifies the AZ where the backend server is running. |
name |
String |
Definition: Specifies the backend server name. Note: The name is not an ECS name. |
project_id |
String |
Definition: Specifies the project ID of the backend server. |
admin_state_up |
Boolean |
Definition: Specifies the administrative status of the backend server. Constraints: Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether ECSs exist. If ECSs exist, the value is true. Otherwise, the value is false. Range: true or false |
subnet_cidr_id |
String |
Definition: Specifies the ID of the IPv4 or IPv6 subnet where the backend server resides. neutron_subnet_id defines IPv4 subnets, and neutron_network_id defines IPv6 subnets. You can query parameter neutron_subnet_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets) to get the IPv4 subnet ID. You can query parameter neutron_network_id in the response by calling the API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets) to get the IPv6 subnet ID. Constraints:
|
protocol_port |
Integer |
Definition: Specifies the port used by the backend server to receive requests. Constraints: protocol_port must be set to 0 for gateway load balancers with IP backend server groups associated.
NOTE:
This parameter can be left blank because it does not take effect if any_port_enable is set to true for a backend server group.
|
weight |
Integer |
Definition: Specifies the weight of the backend server. Requests are routed based on the load balancing algorithm configured for the backend server group and weights of backend servers. The larger the weight is, the higher proportion of requests the backend server receives. If the weight is set to 0, the backend server will not accept new requests. Constraints: If lb_algorithm is set to SOURCE_IP or QUIC_CID, this parameter will not take effect. Range: 0 to 100 Default value: 1 |
address |
String |
Definition: Specifies the IP address of the backend server. Constraints:
|
ip_version |
String |
Definition: Specifies the IP address version supported by the backend server. The version depends on the value of address returned by the system. Range: v4 or v6 |
operating_status |
String |
Definition: Specifies the operating status of the backend server. Range:
Multiple statuses can be used for query in the format of operating_status=xxx&operating_status=xxx. |
status |
Array of MemberStatus objects |
Definition: Specifies the health status of the backend server. Constraints:
|
reason |
Specifies why health check fails. |
|
created_at |
String |
Definition: Specifies the creation time. The value must be a UTC time in the format of yyyy-MM-dd'T'HH:mm:ss'Z'. |
updated_at |
String |
Definition: Specifies the update time. The value must be a UTC time in the format of yyyy-MM-dd'T'HH:mm:ss'Z'. |
member_type |
String |
Definition: Specifies the backend server type. Range:
|
instance_id |
String |
Definition: Specifies the ID of the instance associated with the backend server. If this parameter is left blank, the backend server is not a real device. It may be an IP address. |
Parameter |
Type |
Description |
---|---|---|
listener_id |
String |
Definition: Specifies the listener ID. |
operating_status |
String |
Definition: Specifies the operating status of the backend server. Range:
|
reason |
Specifies why health check fails. |
|
created_at |
String |
Specifies the time when the backend server group was created. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). |
updated_at |
String |
Specifies the time when the backend server group was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). |
Parameter |
Type |
Description |
---|---|---|
reason_code |
String |
Definition: Specifies the code of the health check failures. Range:
|
expected_response |
String |
Definition: Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP, HTTPS, or GRPC. The status code cannot be null if reason_code is RESPONSE_MISMATCH. Range:
|
healthcheck_response |
String |
Definition: Specifies the returned HTTP status code in the response. This parameter will take effect only when type is set to HTTP, HTTPS, or GRPC. The status code cannot be null if reason_code is RESPONSE_MISMATCH. Range:
|
Example Requests
-
Example 1: Adding a backend server
POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members { "member" : { "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74", "protocol_port" : 89, "name" : "My member", "address" : "120.10.10.16" } }
-
Example 2: Adding an IP address as a backend server
POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members { "member" : { "protocol_port" : 89, "name" : "My member", "address" : "120.10.10.16" } }
-
Example 3: Adding a backend server to an IP backend server group
POST https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members { "member" : { "protocol_port" : 0, "name" : "My IP pool member", "address" : "120.10.10.16" } }
Example Responses
Status code: 201
Successful request.
{ "member" : { "name" : "My member", "weight" : 1, "admin_state_up" : false, "subnet_cidr_id" : "c09f620e-3492-4429-ac15-445d5dd9ca74", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "address" : "120.10.10.16", "protocol_port" : 89, "id" : "1923923e-fe8a-484f-bdbc-e11559b1f48f", "operating_status" : "NO_MONITOR", "status" : [ { "listener_id" : "427eee03-b569-4d6c-b1f1-712032f7ec2d", "operating_status" : "NO_MONITOR" } ], "ip_version" : "v4" }, "request_id" : "f354090d-41db-41e0-89c6-7a943ec50792" }
Status Codes
Status Code |
Description |
---|---|
201 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.