Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Databases of a Primary HTAP Instance
Updated on 2025-09-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Databases of a Primary HTAP Instance

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/htap/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 contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Standard HTAP instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Definition

Number of records to be queried.

Constraints

N/A

Range

N/A

Default Value

100

offset

No

String

Definition

Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. If the value is set to 0, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.

Constraints

N/A

Range

N/A

Default Value

0

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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

databases

No

Array of strings

Definition

Names of databases to be queried.

Constraints

Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed. For a fuzzy search, input just one database name.

Range

N/A

Default Value

N/A

source_instance_id

No

String

Definition

ID of the source instance whose database is to be queried. The value is compliant with the UUID format.

Constraints

The value contains 36 characters. Only letters and digits are allowed.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

databases

Array of strings

Definition

Database names.

Range

N/A

total_count

Integer

Definition

Number of databases.

Range

N/A

timestamp

Integer

Definition

Query timestamp.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Request

Querying the first 10 databases of the instance whose ID is 1f6305e9ac4443b8a79f1bfd3a523002in07

GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/htap/databases?limit=10&offset=1

{
  "databases" : [ ],
  "source_instance_id" : "1f6305e9ac4443b8a79f1bfd3a523002in07"
}

Example Response

Status code: 200

Success.

{
  "databases" : [ "INFORMATION_SCHEMA", "connections_db1_08759", "connections_db1_31465", "default", "information_schema", "system" ],
  "total_count" : 6
}

Status code: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)