Batch Adding Backend Servers
Function
This API is used to add backend servers to the specified backend server group in batches. You can add up to 200 backend servers at a time to a backend server group.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/elb/pools/{pool_id}/members/batch-add
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pool_id |
Yes |
String |
Definition: Specifies the backend server group ID. Constraints: N/A Range: N/A Default value: N/A |
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 |
---|---|---|---|
members |
Yes |
Array of BatchCreateMembersOption objects |
Definition: Specifies the request parameters for adding backend servers in batches. Constraints: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Definition: Specifies the backend server name. Constraints: N/A Range: N/A Default value: N/A |
availability_zone |
No |
String |
Definition: Specifies the AZ of the backend server. Constraints: This parameter can be only set for IP as backend servers. If AZ affinity is enabled for the backend server group, this parameter must be set to a valid value for IP as backend servers. Range: AZs available for ECSs in the current region. Default value: N/A |
address |
Yes |
String |
Definition: Specifies the IP address of the backend server. This IP address must be in the subnet specified by subnet_cidr_id, for example, 192.168.3.11. Constraints: If subnet_cidr_id is left blank, IP as backend servers will be added. In this case, the IP address must be an IPv4 address. Range: N/A Default value: N/A |
protocol_port |
Yes |
Integer |
Definition: Specifies the port used by the backend server to receive requests. Constraints: N/A Range: N/A Default value: N/A
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.
|
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:
Range: N/A Default value: N/A |
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: This parameter is invalid when lb_algorithm is set to SOURCE_IP for the backend server group that contains the backend server. Range: 0 to 100 Default value: 1 |
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 (-). |
members |
Array of BatchMember objects |
Definition: Specifies the backend servers. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the backend server ID. Range: N/A
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.
|
name |
String |
Definition: Specifies the backend server name. Range: N/A |
project_id |
String |
Specifies the ID of the project where the backend server is used. Range: N/A |
admin_state_up |
Boolean |
Definition: Specifies the administrative status of the backend server. 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. Range: N/A |
protocol_port |
Integer |
Definition: Specifies the port used by the backend server to receive requests. Range: N/A
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. Range: 0 to 100 Default value: N/A |
address |
String |
Definition: Specifies the IP address of the backend server Range: N/A |
operating_status |
String |
Definition: Specifies the operating status of the backend server. Range:
|
reason |
Definition: Specifies why the health check fails. |
|
status |
Array of MemberStatus objects |
Definition: Specifies the health status of the backend server if listener_id under status is specified. If listener_id under status is not specified, operating_status of member takes precedence. |
member_type |
String |
Definition: Specifies the type of the backend server. 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. Range: N/A |
port_id |
String |
Definition: Specifies the ID of the VPC port bound to the IP address. Range: N/A |
ret_status |
String |
Definition: Specifies the status of adding a backend server. Range:
|
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'. Range: N/A Note: This parameter will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers. |
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'. Range: N/A Note: This parameter will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers. |
Parameter |
Type |
Description |
---|---|---|
listener_id |
String |
Definition: Specifies the listener ID. Range: N/A |
operating_status |
String |
Definition: Specifies the operating status of the backend server. Range:
|
reason |
Definition: Specifies why the 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'. Range: N/A |
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'. Range: N/A |
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
Batch adding backend servers
POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-add { "members" : [ { "name" : "lzs_batch_member1", "weight" : 1, "address" : "192.168.0.48", "protocol_port" : 8080, "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" }, { "name" : "lzs_batch_member2", "weight" : 1, "address" : "192.168.0.49", "protocol_port" : 8080, "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" } ] }
Example Responses
Status code: 201
Successful request.
{ "request_id" : "b5d8bb34d28f3e47b352c14419e8fe04", "members" : [ { "weight" : 1, "admin_state_up" : false, "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d", "address" : "192.168.0.48", "protocol_port" : 8080, "id" : "9346ad28-6971-456a-9711-2917d023930a", "operating_status" : "OFFLINE", "instance_id" : "", "member_type" : "instance", "port_id" : "", "name" : "batch_member1", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398", "ret_status" : "successful" }, { "weight" : 1, "admin_state_up" : false, "project_id" : "04dd36f964000fe22f9ac00bc85b1a1d", "address" : "192.168.0.49", "protocol_port" : 8080, "id" : "94548801-1023-452f-bcf7-6174e77cb772", "operating_status" : "OFFLINE", "instance_id" : "", "member_type" : "instance", "port_id" : "", "name" : "batch_member2", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398", "ret_status" : "successful" } ] }
SDK Sample Code
The SDK sample code is as follows.
Batch adding backend servers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; import java.util.List; import java.util.ArrayList; public class BatchCreateMembersSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); BatchCreateMembersRequest request = new BatchCreateMembersRequest(); request.withPoolId("{pool_id}"); BatchCreateMembersRequestBody body = new BatchCreateMembersRequestBody(); List<BatchCreateMembersOption> listbodyMembers = new ArrayList<>(); listbodyMembers.add( new BatchCreateMembersOption() .withName("lzs_batch_member1") .withAddress("192.168.0.48") .withProtocolPort(8080) .withSubnetCidrId("61da8098-954b-4809-bc5a-b99ccef8a398") .withWeight(1) ); listbodyMembers.add( new BatchCreateMembersOption() .withName("lzs_batch_member2") .withAddress("192.168.0.49") .withProtocolPort(8080) .withSubnetCidrId("61da8098-954b-4809-bc5a-b99ccef8a398") .withWeight(1) ); body.withMembers(listbodyMembers); request.withBody(body); try { BatchCreateMembersResponse response = client.batchCreateMembers(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Batch adding backend servers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = BatchCreateMembersRequest() request.pool_id = "{pool_id}" listMembersbody = [ BatchCreateMembersOption( name="lzs_batch_member1", address="192.168.0.48", protocol_port=8080, subnet_cidr_id="61da8098-954b-4809-bc5a-b99ccef8a398", weight=1 ), BatchCreateMembersOption( name="lzs_batch_member2", address="192.168.0.49", protocol_port=8080, subnet_cidr_id="61da8098-954b-4809-bc5a-b99ccef8a398", weight=1 ) ] request.body = BatchCreateMembersRequestBody( members=listMembersbody ) response = client.batch_create_members(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Batch adding backend servers
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.BatchCreateMembersRequest{} request.PoolId = "{pool_id}" nameMembers:= "lzs_batch_member1" subnetCidrIdMembers:= "61da8098-954b-4809-bc5a-b99ccef8a398" weightMembers:= int32(1) nameMembers1:= "lzs_batch_member2" subnetCidrIdMembers1:= "61da8098-954b-4809-bc5a-b99ccef8a398" weightMembers1:= int32(1) var listMembersbody = []model.BatchCreateMembersOption{ { Name: &nameMembers, Address: "192.168.0.48", ProtocolPort: int32(8080), SubnetCidrId: &subnetCidrIdMembers, Weight: &weightMembers, }, { Name: &nameMembers1, Address: "192.168.0.49", ProtocolPort: int32(8080), SubnetCidrId: &subnetCidrIdMembers1, Weight: &weightMembers1, }, } request.Body = &model.BatchCreateMembersRequestBody{ Members: listMembersbody, } response, err := client.BatchCreateMembers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot