Querying DB Instances in the Recycle Bin

API Description

This API is used to query DB instances in the recycle bin.

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:listRecycleInstances	list	-	-	dds:instance:list	-

URI

URI format
GET /v3/{project_id}/recycle-instances

URI example

https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances

**Table 1** Request Parameters
Name	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A
project_id	Yes	String	Definition Project ID of a tenant in a region. Obtain the project ID by following the instructions in Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Name	Mandatory	Type	Description
offset	No	Integer	Definition Index offset. If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data. Constraints The value cannot be a negative number. Range N/A Default Value 0
limit	No	Integer	Definition Number of records displayed on each page. Constraints The value cannot be a negative number. Range N/A Default Value 100

Request

None

Response

Parameter description

**Table 3** Response body parameters
Name	Type	Description
total_count	Integer	Definition Total number of records. Range N/A
instances	Array of Table 4 objects	Definition Instance information. Range N/A

**Table 4** RecycleInstance
Name	Type	Description
id	String	Definition DB instance ID. Range N/A
name	String	Definition DB instance name. Range N/A
mode	String	Definition DB instance type. Cluster, replica set, and single node instances are supported. Range Sharding: cluster instance ReplicaSet: replica set instance Single: single node instance
datastore	Table 5 object	Definition Database information. Range N/A
pay_mode	String	Definition Billing mode. Range 0: indicates the instance is billed on a pay-per-use basis. 1: indicates the instance is billed based on a yearly/monthly basis.
enterprise_project_id	String	Definition Enterprise project ID. The value 0 indicates the default enterprise project. Range N/A
backup_id	String	Definition Backup ID. Range N/A
created_at	String	Definition Creation time. Range N/A
deleted_at	String	Definition Deletion time. Range N/A
retained_until	String	Definition Retention end time. Range N/A

**Table 5** RecycleDatastore
Name	Type	Description
type	String	Definition Database type. Range The value is DDS-Community.
version	String	Definition Database version. Versions 3.4, 4.0, 4.2, 4.4, and 5.0 are supported. Range The value can be 3.4, 4.0, 4.2, 4.4, or 5.0.

Example Request

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances?offset=0&limit=100

Example Response

Status code: 200

Success.

{ 
  "total_count" : 1, 
  "instances" : [ { 
    "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in02", 
    "name" : "test1", 
    "mode" : "ReplicaSet", 
    "datastore" : { 
      "type" : "DDS-Community", 
      "version" : "4.0" 
    }, 
    "pay_mode" : "0", 
    "enterprise_project_id" : "0", 
    "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", 
    "created_at" : "2022-01-01T10:00:00", 
    "deleted_at" : "2022-02-01T10:00:00", 
    "retained_until" : "2022-05-01T10:00:00"
  } ] 
}