Querying Instances in the Recycle Bin

Function

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

Authorization Information

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

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

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
gaussdbfornosql:instance:listRecycleInstances	List	-	-	nosql:instance:list	-

URI

GET /v3/{project_id}/recycle-instances

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a user in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Explanation: Index offset. The query starts from the next piece of data indexed by this parameter. Constraints: The value must be greater than or equal to 0. Values: N/A Default value: 0: The query starts from the first piece of data.
limit	No	Integer	Explanation: Maximum records to be queried Constraints: N/A Values: 1–100 Default value: 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints: N/A Values: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Explanation: Total number of records Values: N/A
instances	Array of objects	Explanation: Instance information. For details, see Table 5. Values: N/A

**Table 5** RecycleInstance
Parameter	Type	Description
id	String	Explanation: Instance ID Values: N/A
name	String	Explanation: Instance name Values: N/A
mode	String	Explanation: Instance type Values: Cluster: proxy cluster GeminiDB Cassandra, GeminiDB Influx, or GeminiDB Redis instance CloudNativeCluster: cluster GeminiDB Cassandra, Influx, or Redis instance with cloud native storage RedisCluster: Redis Cluster GeminiDB Redis instance with classic storage Replication: primary/standby GeminiDB Redis instance with classic storage InfluxdbSingle: single-node GeminiDB Influx instance with classic storage ReplicaSet: GeminiDB Mongo instance in a replica set
product_type	String	Explanation: Product type Values: This parameter is used for GeminiDB Redis instances with cloud native storage. The value can be: Standard Capacity
datastore	object	Explanation: Database information For details, see Table 6. Values: N/A
charge_mode	String	Explanation: Billing mode Values: prePaid: yearly/monthly postPaid: indicates that the billing mode is pay-per-use.
enterprise_project_id	String	Explanation: Enterprise project ID. 0 indicates that the default enterprise project is used. Values: N/A
backup_id	String	Explanation: Backup ID Values: N/A
created_at	String	Explanation: Instance creation time Values: N/A
deleted_at	String	Explanation: Instance deletion time Values: N/A
retained_until	String	Explanation: Retention end time Values: N/A

**Table 6** RecycleDatastore
Parameter	Type	Description
type	String	Explanation: Database type Values: cassandra: GeminiDB Cassandra instance mongodb: GeminiDB Mongo instance influxdb: GeminiDB Influx instance redis: GeminiDB Redis instance
version	String	Explanation: Database version Values: N/A

Example Request

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-instances?offset=0&limit=100

Example request body
None

Example Response

Status code: 200

Successful request

{ 
  "total_count" : 1, 
  "instances" : [ { 
    "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", 
    "name" : "test", 
    "mode" : "Cluster", 
    "datastore" : { 
      "type" : "cassandra", 
      "version" : "3.11" 
    }, 
    "charge_mode" : "postPaid", 
    "enterprise_project_id" : "0", 
    "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", 
    "created_at" : "2022-01-01T10:00:00", 
    "deleted_at" : "2022-02-01T11:00:00", 
    "retained_until" : "2022-02-02T11:00:00" 
  } ] 
}