Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Databases of a StarRocks Instance
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF

Querying Databases of a StarRocks Instance

Function

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

URI

GET /v3/{project_id}/instances/{instance_id}/starrocks/databases

Table 1 URI 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

StarRocks instance ID, which is compliant with the UUID format.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

String

Number of records to be queried.

offset

No

String

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.

database_name

No

String

Name of the database to be queried. Fuzzy search is supported. The value can contain 3 to 128 characters. Only uppercase letters, lowercase letters, digits, and underscores (_) are allowed.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

X-Language

Yes

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

databases

Array of strings

Database name.

total_count

Integer

Number of databases.

timestamp

Integer

Query timestamp.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the first 10 databases of a StarRocks instance with instance ID specified

GET https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases?limit=10&offset=1&database_name=

Example Response

Status code: 200

Success.

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

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)