Help Center/ GeminiDB/ API Reference/ API v3/ Backups and Restorations/ Querying Instances in the Recycle Bin
Updated on 2026-09-22 GMT+08:00
View PDF
Share

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 parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

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.

Range

N/A

Default Value

0: The query starts from the first piece of data.

limit

No

Integer

Definition

Maximum records to be queried

Constraints

N/A

Range

1–100

Default Value

100

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Definition

Total number of records

Range

N/A

instances

Array of Table 5 objects

Definition

Instance information.
Table 5 RecycleInstance

Parameter

Type

Description

id

String

Definition

Instance ID

Range

N/A

name

String

Definition

Instance name

Range

N/A

mode

String

Definition

Instance type

Range

  • Cluster: Classic storage-based GeminiDB Cassandra, Influx, Redis (with proxy), and DynamoDB-Compatible cluster instances
  • CloudNativeCluster: Cloud native storage-based GeminiDB Cassandra, Influx, Redis, and DynamoDB-Compatible cluster instances
  • 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

Definition

Product type

This parameter is used for GeminiDB Redis instances with cloud native storage.

Range

Capacity: capacity-oriented

data_store

Table 6 object

Definition

Database information

charge_type

String

Definition

Billing mode

Range

  • prePaid: yearly/monthly
  • postPaid: indicates that the billing mode is pay-per-use.

enterprise_project_id

String

Definition

Enterprise project ID. The value 0 indicates that the default enterprise project is used.

Range

N/A

backup_id

String

Definition

Backup ID

Range

N/A

created_at

String

Definition

Instance creation time (UTC). The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

Range

N/A

deleted_at

String

Definition

Instance deletion time (UTC). The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

Range

N/A

retained_until

String

Definition

Retention end time (UTC) of recycled backups. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset.

Range

N/A
Table 6 RecycleDatastore

Parameter

Type

Description

type

String

Definition

Database type

Range

  • cassandra: GeminiDB Cassandra instance
  • mongodb: GeminiDB Mongo instance
  • influxdb: GeminiDB Influx instance
  • redis: GeminiDB Redis instance
  • dynamodb: GeminiDB DynamoDB-Compatible instance

version

String

Definition

Database version

Range

N/A

Example Requests

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

Example Responses

Status code: 200

Success

{ 
  "total_count" : 1, 
  "instances" : [ { 
    "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", 
    "name" : "test", 
    "mode" : "Cluster", 
    "data_store" : { 
      "type" : "cassandra", 
      "version" : "3.11" 
    }, 
    "charge_type" : "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" 
  } ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations