Deleting Shard or Config IP Addresses of a Cluster Instance

Description

This API is used to delete the IP addresses of shard or config nodes.

Constraints

• Frozen instances do not support this operation.
• During deletion, the IP address of the corresponding node cannot be accessed.
• During the deletion, the shard or config node will be restarted. The DDS DB instance is unavailable during the restart. Exercise caution when performing this operation.
• Cluster instances of Community Edition 4.0 or later are supported.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  dds:instance:deleteIp	write	instance	g:EnterpriseProjectId	-	-

URI

• URI format

  DELETE /v3/{project_id}/instances/{instance_id}/ip

  Table 1 URI parameters

  Name	Type	Mandatory	Description
  project_id	String	Yes	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	String	Yes	Definition Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints N/A Range N/A Default Value N/A

Request

• Parameter description

  Table 2 Request header parameters

  Name	Type	IN	Mandatory	Description
  X-Auth-Token	string	header	Yes	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

  Request body parameters

  Name	Type	Mandatory	Description
  type	String	Yes	Definition Type of the group whose IP addresses are to be deleted. Constraints N/A Range shard: IP addresses of all shard groups will be deleted. config: The IP address of the config group will be deleted. Default Value N/A

Example Request

• Deleting the config IP address of the instance whose ID is 520c58ba00a3497e97ce0b9604874dd6in02

  DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/ip 
    
  { 
     "type" : "config" 
  }

• Deleting all shard IP addresses of the instance whose ID is 520c58ba00a3497e97ce0b9604874dd6in02

  DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/520c58ba00a3497e97ce0b9604874dd6in02/ip 
    
  { 
     "type" : "shard" 
  }

Response

Example Response

None

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.