Deleting Shards

Function

This API is used to delete shards.

Constraints

Cluster instances of Community Edition 4.0 or later support this function.
Before deleting shards, read the precautions carefully and fully evaluate the impact.

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:deleteShards

write

instance

g:EnterpriseProjectId

-

-

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

URI

POST /v3/{project_id}/instances/{instance_id}/shards/batch-delete

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	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	Yes	string	path	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 Parameters

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
ids	Yes	Array of strings	Definition Group ID. You can call the API used for querying instances and details to obtain the value. Constraints Only shard groups are supported. Range N/A Default Value N/A

Response Parameters

Status code:202

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. This parameter is returned only for pay-per-use DB instances. Range N/A
order_id	String	Definition Order ID. This parameter is returned only for yearly/monthly DB instances. Range N/A

Example Request

Deleting shards of a cluster instance whose ID is e73893ef73754465a8bd2e0857bbf13ein02 (with shard group ID of 51ba2ff4d1194e61ad231aa40d90aeb7gr02)

https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/shards/batch-delete    
{    "ids" : [ "51ba2ff4d1194e61ad231aa40d90aeb7gr02" ]  
}

Example Response

{    
  "job_id" : "f6b99612-2e70-4a1d-82cc-285c06726155" 
}

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.