Deleting Proxy Nodes
Function
This API is used to delete proxy nodes. Before calling this API: Proxy instances are unavailable for DB instances in a DeC.
- Learn how to authenticate it.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/reduce
| 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 The value contains 36 characters with a suffix of po01. 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 deleted. Constraints The value is an integer from 1 to 14. Range 1–14 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
Deleting proxy nodes
PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/151c14381ac14ecfb9703a745b992677po01/reduce
{
"node_num" : 1
} 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.