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

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.

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

instance_id

Yes

String

Instance ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Index position.

  • Index position. The query starts from the dedicated resource created after the dedicated resource indexed by this parameter in a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.
  • The value must be no less than 0.
  • If this parameter is not transferred, offset is set to 0 by default, indicating that the query starts from the latest created dedicated resource.

limit

No

Integer

Maximum of dedicated resources to be queried.

  • The value ranges from 1 to 100. If this parameter is not transferred, the first 100 instance records are queried by default.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Total number of records.

database_names

Array of strings

Database names.

Example Requests

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

Example Responses

Status code: 200

Success

{ 
  "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