Updating a Backend Server
Function
This API is used to update a backend server.
Constraints
If the provisioning status of the associated load balancer is not ACTIVE, the backend server cannot be updated.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/elb/pools/{pool_id}/members/{member_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
member_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. |
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 |
---|---|---|---|
member |
Yes |
UpdateMemberOption object |
Specifies the backend server. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
admin_state_up |
No |
Boolean |
Specifies the administrative status of the backend server. Although this parameter can be used in the APIs for creating and updating backend servers, its actual value depends on whether cloud servers exist. If cloud servers exist, the value is true. Otherwise, the value is false. This parameter is unsupported. Please do not use it. |
name |
No |
String |
Specifies the backend server name. Minimum: 0 Maximum: 255 |
weight |
No |
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, this parameter will not take effect. Minimum: 0 Maximum: 100 |
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. Minimum: 1 Maximum: 65535 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. The value is automatically generated. |
member |
Member object |
Specifies the backend server. |
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. Note: The name is not an ECS name. |
project_id |
String |
Specifies the project ID of the backend server. |
pool_id |
String |
Specifies the ID of the backend server group to which the backend server belongs. This parameter is unsupported. Please do not use it. |
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 cloud servers exist. If cloud servers 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. This parameter can be left blank, indicating that IP as a Backend has been enabled for the load balancer. In this case, IP addresses of these servers must be IPv4 addresses, and the protocol of the backend server group must be TCP, HTTP, or HTTPS. The IPv4 or IPv6 subnet must be in the same VPC as the subnet of the load balancer. |
protocol_port |
Integer |
Specifies the port used by the backend server to receive requests.
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. Minimum: 1 Maximum: 65535 |
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, this parameter will not take effect. Minimum: 0 Maximum: 100 |
address |
String |
Specifies the private IP address bound to the backend server.
|
ip_version |
String |
Specifies the IP version supported by the backend server. The value can be v4 (IPv4) or v6 (IPv6), depending on the value of address returned by the system. |
device_owner |
String |
Specifies whether the backend server is associated with an ECS.
This parameter is unsupported. Please do not use it. |
device_id |
String |
Specifies the ID of the ECS with which the backend server is associated. If this parameter is left blank, the backend server is not associated with an ECS. This parameter is unsupported. Please do not use it. |
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. |
loadbalancer_id |
String |
Specifies the ID of the load balancer with which the backend server is associated. This parameter is unsupported. Please do not use it. |
loadbalancers |
Array of ResourceID objects |
Specifies the IDs of the load balancers associated with the backend server. This parameter is unsupported. Please do not use it. |
created_at |
String |
Specifies the time when a backend server was added. 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 a backend server 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. |
member_type |
String |
Specifies the type of the backend server. Values:
|
instance_id |
String |
Specifies the ID of the ECS used as the backend server. If this parameter is left blank, the backend server is not an ECS. For example, it may be an IP address. |
Parameter |
Type |
Description |
---|---|---|
listener_id |
String |
Specifies the listener ID. |
operating_status |
String |
Specifies the health status of the backend server. The value can be one of the following:
|
Example Requests
Changing the weight of a backend server
PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75/members/1923923e-fe8a-484f-bdbc-e11559b1f48f { "member" : { "name" : "My member", "weight" : 10 } }
Example Responses
Status code: 200
Successful request.
{ "member" : { "name" : "My member", "weight" : 10, "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", "ip_version" : "v4" }, "request_id" : "e7b569d4-15ad-494d-9dd9-8cd740eef8f6" }
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