Updated on 2026-09-22 GMT+08:00

Obtaining GeminiDB Cassandra Instance Table Information That Is Restored Using Tables

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

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:backup:list

List

-

-

nosql:backup:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:backup:list	List	-	-	nosql:backup:list	-

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

**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
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
database_name	Yes	String	Definition Database name Constraints N/A Range N/A Default Value N/A
offset	No	Integer	Definition Index offset Constraints N/A Range ≥ 0 Default Value 0
limit	No	Integer	Definition Maximum number of tables to be queried Constraints N/A Range 1–100 Default Value 100: 100 tables are queried by default.

**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

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records Range N/A
table_names	Array of strings	Definition Table names

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

Status code: 200

Success

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

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Backups and Restorations