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.

URI

DELETE /v2/{project_id}/instances/{instance_id}/groups/{group_id}/replications/{node_id}/remove-ip

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	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

**Table 2** Response body parameters
Parameter	Type	Description
job_id	String	ID of the IP address removing task.

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Error message. Maximum: 1024
error_code	String	Error code. Maximum: 9
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum: 1024

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.