Adding Proxy Nodes
Function
This API is used to add proxy nodes. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge
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 |
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 |
---|---|---|---|
node_num |
Yes |
Integer |
Definition Number of proxy nodes to be added. Constraints There are a maximum of 16 proxy nodes for a DB instance. Range 1–14 Default Value N/A |
proxy_id |
No |
String |
Definition Proxy instance ID. Constraints If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, you must configure this parameter. Range The value contains 36 characters with a suffix of po01. Only letters and digits are allowed. Default Value N/A |
Response Parameters
Status code: 201
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
Adding proxy nodes
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge { "node_num" : 2, "proxy_id" : "151c14381ac14ecfb9703a745b992677po01" }
Example Response
Status code: 201
Success.
{ "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" }
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