Updating Backend Instances
Function
This API is used to update the backend instances of a specified VPC channel. During the update, the request parameters overwrite the backend instances of the corresponding cloud server group. If no cloud server group is specified, all cloud server groups are overwritten.
Backend instances cannot be updated for a reference load balance channel.
URI
PUT /v2/{project_id}/apic/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. |
instance_id |
Yes |
String |
Instance ID. |
vpc_channel_id |
Yes |
String |
VPC channel ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
members |
No |
Array of MemberInfo objects |
Backend server list. |
member_group_name |
No |
String |
Backend server group to be modified. If this parameter is not specified, all backends defined by members for the VPC channel are modified. If this parameter is specified, only the backend instances in the backend server group defined by members are modified. Input parameters of other backend server groups are ignored. For example, if member_group_name=primary is passed, only backend instances of backend server group primary in members are modified. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host |
No |
String |
Backend server address. This parameter is valid when the member type is IP address. |
weight |
No |
Integer |
Backend server weight. The higher the weight is, the more requests a cloud server will receive. It is valid only when the VPC channel type is set to 2. |
is_backup |
No |
Boolean |
Indicates whether it is a standby node. After this parameter is enabled, the corresponding backend service functions as the standby node and works only when all non-standby nodes are faulty. The instance must be upgraded to the corresponding version to support this function. If the instance does not support this function, contact technical support. |
member_group_name |
No |
String |
Name of the backend server group. Select a server group for the backend service address so that the backend addresses of the corresponding server group can be changed in a unified manner. |
status |
No |
Integer |
Backend server status.
|
port |
No |
Integer |
Backend server port. |
ecs_id |
No |
String |
Backend ECS ID This parameter is mandatory when the backend instance type is ECS. It can include letters, digits, hyphens (-), and underscores (_) (max. 64 characters). |
ecs_name |
No |
String |
Backend ECS name This parameter is mandatory when the backend instance type is ECS. It can include letters, digits, hyphens (-), underscores (_), and periods (.) (max. 64 characters). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
size |
Integer |
Length of the returned resource list. |
total |
Long |
Number of resources that match the query conditions. |
members |
Array of VpcMemberInfo objects |
Backend server group ID. |
Parameter |
Type |
Description |
---|---|---|
host |
String |
Backend server address. This parameter is valid when the member type is IP address. |
weight |
Integer |
Backend server weight. The higher the weight is, the more requests a cloud server will receive. It is valid only when the VPC channel type is set to 2. |
is_backup |
Boolean |
Indicates whether it is a standby node. After this parameter is enabled, the corresponding backend service functions as the standby node and works only when all non-standby nodes are faulty. The instance must be upgraded to the corresponding version to support this function. If the instance does not support this function, contact technical support. |
member_group_name |
String |
Name of the backend server group. Select a server group for the backend service address so that the backend addresses of the corresponding server group can be changed in a unified manner. |
status |
Integer |
Backend server status.
|
port |
Integer |
Backend server port. |
ecs_id |
String |
Backend ECS ID This parameter is mandatory when the backend instance type is ECS. It can include letters, digits, hyphens (-), and underscores (_) (max. 64 characters). |
ecs_name |
String |
Backend ECS name This parameter is mandatory when the backend instance type is ECS. It can include letters, digits, hyphens (-), underscores (_), and periods (.) (max. 64 characters). |
id |
String |
VPC channel list. |
vpc_channel_id |
String |
Backend instance ID. |
create_time |
String |
VPC channel ID. |
member_group_id |
String |
Time when the backend server is added to the VPC channel. |
health_status |
String |
Health status of the backend instance of the load balance channel. The value can be unknown, healthy, or unhealthy, indicating that no health check is performed, healthy, or unhealthy, respectively. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
-
Modify the IP backend server information of a specified VPC channel server group by changing backend server to a non-standby node and resetting the weight.
{ "member_group_name" : "primary", "members" : [ { "host" : "192.168.2.25", "weight" : 1, "is_backup" : false, "member_group_name" : "primary" } ] }
-
Modify the information about a cloud-server backend server of a specified VPC channel by changing the weight.
{ "members" : [ { "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "weight" : 2 } ] }
Example Responses
Status code: 200
OK
-
Example 1
{ "total" : 1, "size" : 1, "members" : [ { "host" : "192.168.2.25", "weight" : 1, "is_backup" : false, "member_group_name" : "primary", "port" : 22, "status" : 1, "ecs_id" : "192.168.2.25", "ecs_name" : "192.168.2.25", "id" : "683b6807cad54122a6777ad047a6178e", "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "create_time" : "2020-07-23T09:13:24Z", "member_group_id" : "631b551cddda40478ef720163a9412ed" } ] }
-
Example 2
{ "total" : 1, "size" : 1, "members" : [ { "host" : "192.168.0.17", "weight" : 2, "is_backup" : false, "member_group_name" : "primary", "port" : 22, "status" : 1, "ecs_id" : "1082720c-3c15-409c-9ae3-4983ddfb6a9d", "ecs_name" : "APIGtest02", "id" : "5c868f0224084710a1e188b7d3057c52", "vpc_channel_id" : "105c6902457144a4820dff8b1ad63331", "create_time" : "2020-07-23T09:03:53Z", "member_group_id" : "631b551cddda40478ef720163a9412ed" } ] }
Status code: 400
Bad Request
{ "error_code" : "APIG.2004", "error_msg" : "The parameter value is outside the allowable range,parameterName:weight. Please refer to the support documentation" }
Status code: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
Status code: 404
Not Found
{ "error_code" : "APIG.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" }
Status code: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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