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

Obtaining GeminiDB Cassandra Instance Table Information That Is Restored Using Tables

Function

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

Constraints

  • This API supports only GeminiDB Cassandra API.

URI

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

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

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

Constraints:

N/A

Values:

N/A

Default value:

N/A

instance_id

Yes

String

Explanation:

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

Values:

N/A

Default value:

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

database_name

Yes

String

Explanation:

Database name

Constraints:

N/A

Values:

N/A

Default value:

N/A

offset

No

Integer

Explanation:

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

Values:

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

Explanation:

Maximum dedicated resources to be queried

Constraints:

N/A

Values:

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

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

table_names

Array of strings

Explanation:

Table names

Values:

N/A

Example Request

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

Example Response

Status code: 200

Success

{ 
  "total_count" : 1, 
  "table_names" : [ "tb01" ] 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backups and Restorations