Batch Updating Backend Servers
Function
This API is used to update backend servers in a given backend server group in batches. You can update up to 200 backend servers at a time from a backend server group.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/elb/pools/{pool_id}/members/batch-update
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pool_id |
Yes |
String |
Specifies the ID of the backend server group. |
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the token used for IAM authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
members |
Yes |
Array of BatchUpdateMembersOption objects |
Specifies the backend server. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
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 has already associated with the load balancer. |
admin_state_up |
No |
Boolean |
Specifies the administrative status of the backend server. The value can be true or false. 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. |
name |
No |
String |
Specifies the backend server name. |
protocol_port |
No |
Integer |
Specifies the port used by the backend server to receive requests.
NOTE:
This parameter cannot be updated if any_port_enable is set to true for a backend server group. |
weight |
No |
Integer |
Specifies the weight of the backend server. Requests are routed to backend servers in the backend server group based on their weights. If the weight is set to 0, the backend server will not accept new requests. This parameter is invalid when lb_algorithm of the backend server group to which the backend server belongs is set to SOURCE_IP. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. Note: The value is automatically generated. |
members |
Array of BatchUpdateMember objects |
Specifies the backend servers. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
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 has already associated with the load balancer. |
name |
String |
Specifies the backend server name. |
project_id |
String |
Specifies the ID of the project where the backend server is used. |
admin_state_up |
Boolean |
Specifies the administrative status of the backend server. The value can be true or false. 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. |
subnet_cidr_id |
String |
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 parameters neutron_subnet_id and neutron_network_id in the response by calling the API GET https://{VPC_Endpoint}/v1/{project_id}/subnets to get the IPv4 subnet ID and IPv6 subnet ID respectively. Notes and constraints:
|
protocol_port |
Integer |
Specifies the port used by the backend server to receive requests. Notes and constraints:
|
weight |
Integer |
Specifies the weight of the backend server. Requests are routed to backend servers in the same backend server group based on their weights. The value ranges from 0 to 100, and the default value is 1. 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. If lb_algorithm is set to SOURCE_IP or QUIC_CID, this parameter will not take effect. |
address |
String |
Specifies the private IP address bound to the backend server.
|
operating_status |
String |
Specifies the health status of the backend server if listener_id under status is not specified. The value can be one of the following:
|
status |
Array of MemberStatus objects |
Specifies the health status of the backend server if listener_id is specified. |
member_type |
String |
Specifies the type of the backend server. The value can be:
|
instance_id |
String |
Specifies the ID of the instance associated with the backend server. If this parameter is left blank, the backend server is not an ECS. It may be an IP address. |
port_id |
String |
Specifies the ID of the VPC port bound to the IP address. |
created_at |
String |
Specifies the time when the health check was configured. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). This is a new field in this version, and it 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 |
Specifies the time when the health check was updated. The format is yyyy-MM-dd'T'HH:mm:ss'Z' (UTC time). This is a new field in this version, and it 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 |
Specifies the listener ID. |
operating_status |
String |
Specifies the health status of the backend server if listener_id under status is not specified. The value can be one of the following:
|
Example Requests
Modifying backend servers in batches
POST https://{ELB_Endpoint}/v3/04dd36f964000fe22f9ac00bc85b1a1d/elb/pools/04a9bc65-b75b-478d-b4d6-e693bb61dd35/members/batch-update { "members" : [ { "name" : "batch_update_member1", "weight" : 1, "admin_state_up" : true, "protocol_port" : 8080, "id" : "61da8098-954b-4809-bc5a-b99ccef8a398" }, { "name" : "batch_update_member2", "weight" : 2, "admin_state_up" : true, "protocol_port" : 8081, "id" : "61da8098-954b-4809-bc5a-b99ccef8a398" } ] }
Example Responses
Status code: 200
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", "name" : "batch_member1", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" }, { "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", "name" : "batch_member2", "subnet_cidr_id" : "61da8098-954b-4809-bc5a-b99ccef8a398" } ] }
SDK Sample Code
The SDK sample code is as follows.
Modifying backend servers in batches
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 BatchUpdateMembersSolution { 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(); BatchUpdateMembersRequest request = new BatchUpdateMembersRequest(); request.withPoolId("{pool_id}"); BatchUpdateMembersRequestBody body = new BatchUpdateMembersRequestBody(); List<BatchUpdateMembersOption> listbodyMembers = new ArrayList<>(); listbodyMembers.add( new BatchUpdateMembersOption() .withId("61da8098-954b-4809-bc5a-b99ccef8a398") .withAdminStateUp(true) .withName("batch_update_member1") .withProtocolPort(8080) .withWeight(1) ); listbodyMembers.add( new BatchUpdateMembersOption() .withId("61da8098-954b-4809-bc5a-b99ccef8a398") .withAdminStateUp(true) .withName("batch_update_member2") .withProtocolPort(8081) .withWeight(2) ); body.withMembers(listbodyMembers); request.withBody(body); try { BatchUpdateMembersResponse response = client.batchUpdateMembers(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()); } } } |
Modifying backend servers in batches
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 = BatchUpdateMembersRequest() request.pool_id = "{pool_id}" listMembersbody = [ BatchUpdateMembersOption( id="61da8098-954b-4809-bc5a-b99ccef8a398", admin_state_up=True, name="batch_update_member1", protocol_port=8080, weight=1 ), BatchUpdateMembersOption( id="61da8098-954b-4809-bc5a-b99ccef8a398", admin_state_up=True, name="batch_update_member2", protocol_port=8081, weight=2 ) ] request.body = BatchUpdateMembersRequestBody( members=listMembersbody ) response = client.batch_update_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) |
Modifying backend servers in batches
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 |
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.BatchUpdateMembersRequest{} request.PoolId = "{pool_id}" adminStateUpMembers:= true nameMembers:= "batch_update_member1" protocolPortMembers:= int32(8080) weightMembers:= int32(1) adminStateUpMembers1:= true nameMembers1:= "batch_update_member2" protocolPortMembers1:= int32(8081) weightMembers1:= int32(2) var listMembersbody = []model.BatchUpdateMembersOption{ { Id: "61da8098-954b-4809-bc5a-b99ccef8a398", AdminStateUp: &adminStateUpMembers, Name: &nameMembers, ProtocolPort: &protocolPortMembers, Weight: &weightMembers, }, { Id: "61da8098-954b-4809-bc5a-b99ccef8a398", AdminStateUp: &adminStateUpMembers1, Name: &nameMembers1, ProtocolPort: &protocolPortMembers1, Weight: &weightMembers1, }, } request.Body = &model.BatchUpdateMembersRequestBody{ Members: listMembersbody, } response, err := client.BatchUpdateMembers(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 |
---|---|
200 |
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