更新时间:2025-09-09 GMT+08:00

查询StarRocks数据库

功能介绍

查询StarRocks数据库。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

StarRocks实例ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

String

参数解释

查询记录数。

约束限制

不涉及。

取值范围

1-100。

默认取值

1。

offset

String

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

约束限制

不涉及。

取值范围

≥0。

默认取值

0。

database_name

String

参数解释

查询的数据库名称,支持模糊搜索。

约束限制

字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

databases

Array of strings

参数解释

数据库名称。

取值范围

不涉及。

total_count

Integer

参数解释

数据库数量。

取值范围

不涉及。

timestamp

Integer

参数解释

查询时间戳。

取值范围

不涉及。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询StarRocks实例instance_id的前10个数据库。

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

响应示例

状态码: 200

Success.

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

状态码: 400

Client error.

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

请参见状态码

错误码

请参见错误码