Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Backups and Restorations/ Obtaining GeminiDB Cassandra Instance Database Information That Is Restored Using Tables
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Obtaining GeminiDB Cassandra Instance Database Information That Is Restored Using Tables

Function

This API is used to obtain GeminiDB Cassandra instance database information that is restored using tables.

Constraints

  • This API supports only GeminiDB Cassandra API.

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

    List

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId
    • nosql:database:list
    • nosql:backup:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/databases

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

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which can be obtained by following Querying Instances and Details. If no instance is available, call the API by flowing Creating an Instance to create one.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Index offset. The query starts from the next dedicated resource creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.

Constraints

N/A

Range

The value must be greater than or equal to 0.

Default Value

0: The query starts from the latest dedicated resource created.

limit

No

Integer

Definition

Maximum dedicated resources to be queried

Constraints

N/A

Range

1–100

Default Value

100: 100 instances are queried by default.

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

database_names

Array of strings

Definition

Database names

Range

N/A

Example Requests

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a6d3c8a9857b4c81b3c1fe4802dfa4d0in06/databases?offset=0&limit=10

Example Responses

Status code: 200

Successful response

{ 
  "total_count" : 1, 
  "database_names" : [ "db01" ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations