Removing the IP Address
Function
This API is used to remove the IP address of a read replica from the domain name. After the removal, the read-only domain name will not be resolved to the IP address.
Calling Method
For details, see Calling APIs.
URI
DELETE /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details, see Obtaining a Project ID. |
| instance_id | Yes | String | Instance ID. |
| group_id | Yes | String | Shard ID. |
| node_id | Yes | String | Node ID. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| job_id | String | ID of the IP address removing task. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Parameter description: Error message. Value range: N/A. |
| error_code | String | Parameter description: Error code. Value range: For details, see Error Codes. |
| error_ext_msg | String | Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Parameter description: Error message. Value range: N/A. |
| error_code | String | Parameter description: Error code. Value range: For details, see Error Codes. |
| error_ext_msg | String | Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Parameter description: Error message. Value range: N/A. |
| error_code | String | Parameter description: Error code. Value range: For details, see Error Codes. |
| error_ext_msg | String | Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Parameter description: Error message. Value range: N/A. |
| error_code | String | Parameter description: Error code. Value range: For details, see Error Codes. |
| error_ext_msg | String | Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Parameter description: Error message. Value range: N/A. |
| error_code | String | Parameter description: Error code. Value range: For details, see Error Codes. |
| error_ext_msg | String | Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A. |
Example Requests
POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | IP address removed successfully. |
| 400 | Invalid request. |
| 401 | Invalid authentication information. |
| 403 | The request is rejected. |
| 404 | The requested resource is not found. |
| 500 | Internal service 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.
