Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Management/ Querying Databases
Updated on 2025-07-11 GMT+08:00
View PDF

Querying Databases

Function

This API is used to query databases of a TaurusDB instance. Before calling this API:

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:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Definition:

Instance ID, which uniquely identifies an instance.

Constraints:

N/A

Range:

The value can contain 36 characters with a suffix of in07. 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 an integer and cannot be a negative number.

Range:

≥0

Default value:

0

limit

No

Integer

Definition:

Number of records to be queried.

Constraints:

The value must be an integer and cannot be a negative number.

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.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us
  • zh-cn

Default value:

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

databases

Array of ListGaussMysqlDatabaseInfo objects

Definition:

Database list.

total_count

Integer

Definition:

Total number of databases.

Range:

≥0
Table 5 ListGaussMysqlDatabaseInfo

Parameter

Type

Description

name

String

Definition:

Database name.

Range:

N/A

charset

String

Definition:

Character set used by the database.

Range:

N/A

users

Array of GaussMySqlDatabaseInfo objects

Definition:

List of authorized database users.
Table 6 GaussMySqlDatabaseInfo

Parameter

Type

Description

name

String

Definition:

Database username.

Range:

N/A

host

String

Definition:

Host IP address.

Range:

N/A

readonly

Boolean

Definition:

Whether the permission is read-only.

Range:

  • true: read-only
  • false: read/write

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying databases

Example Response

Status code: 200

Success.

{
  "databases" : [ {
    "name" : "test",
    "charset" : "utf8mb4",
    "users" : [ {
      "name" : "gaussdb-mysql-instance1",
      "host" : "127.0.0.1",
      "readonly" : false
    } ]
  } ],
  "total_count" : 1
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Management