文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 查询StarRocks数据库
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询StarRocks数据库

功能介绍

查询StarRocks数据库。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

StarRocks实例ID，严格匹配UUID规则。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

查询记录数。

offset

否

String

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

database_name

否

String

查询的数据库名称，支持模糊搜索。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

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

X-Language

是

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 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://{localhost}/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" : "实例不存在"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版