Changing the Routing Policy of a Proxy Instance
Function
This API is used to change the routing policy of a proxy instance. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
Constraints
This API is in the open beta test (OBT) phase. To use this API, submit a service ticket.
URI
PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/route-mode
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A |
instance_id |
Yes |
String |
Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. Default Value N/A |
proxy_id |
Yes |
String |
Definition Proxy instance ID, which is compliant with the UUID format. Constraints N/A Range ID of the proxy instance associated with the instance. Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A |
X-Language |
No |
String |
Definition Request language type. Constraints N/A Range Default Value en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
route_mode |
Yes |
Integer |
Definition Routing policy of the proxy instance. Constraints N/A Range
Default Value N/A |
master_weight |
No |
Integer |
Definition Weight of the primary node. Constraints The value range depends on the routing policy. Range Default Value N/A |
readonly_nodes |
No |
Array of ModifyProxyRouteModeWeightReadonlyNode objects |
Definition Weight information of the read replicas. Constraints N/A |
new_node_auto_add_status |
No |
String |
Definition Whether new nodes are automatically associated with proxy instances. Constraints N/A Range
Default Value OFF |
new_node_weight |
No |
Integer |
Definition Read weight of a new node. Constraints The value range depends on the routing policy and whether new nodes are automatically associated. Range
Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Definition Read replica ID. Constraints N/A Range ID of a read replica in the instance. Default Value N/A |
weight |
Yes |
Integer |
Definition Weight of the read replica. Constraints The value depends on the routing policy. Range Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Definition Task ID. Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
- Changing the routing policy of a proxy instance to 0
PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode { "route_mode" : 0, "master_weight" : 100, "readonly_nodes" : { "id" : "d23535333138462880bfa1838fdfced2no07", "weight" : 200 } }
- Changing the routing policy of a proxy instance to 1
PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode { "route_mode" : 1, "master_weight" : 0, "readonly_nodes" : { "id" : "d23535333138462880bfa1838fdfced2no07", "weight" : 1 } }
- Changing the routing policy of a proxy instance to 2
PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/route-mode { "route_mode" : 2, "master_weight" : 1, "readonly_nodes" : { "id" : "d23535333138462880bfa1838fdfced2no07", "weight" : 0 } }
Example Response
Status code: 200
Success.
{ "job_id" : "04efe8e2-9255-44ae-a98b-d87c11411890" }
Status Code
For details, see Status Codes.
Error Code
For details, 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