更新时间:2025-08-29 GMT+08:00
分享

查询HTAP主实例数据库

功能介绍

查询HTAP主实例数据库。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/instances/{instance_id}/htap/databases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释

HTAP标准版实例ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

String

参数解释

查询记录数。

约束限制

不涉及。

取值范围

不涉及。

默认取值

100。

offset

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

表4 请求Body参数

参数

是否必选

参数类型

描述

databases

Array of strings

参数解释

查询的数据库名称。

约束限制

仅支持英文大小写字母、数字以及下划线,模糊搜索时列表元素数目必须为1。

取值范围

不涉及。

默认取值

不涉及。

source_instance_id

String

参数解释

需要查询数据库的源实例ID,严格匹配UUID规则。

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

databases

Array of strings

参数解释

数据库名称。

取值范围

不涉及。

total_count

Integer

参数解释

数据库数量。

取值范围

不涉及。

timestamp

Integer

参数解释

查询时间戳。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及。

error_msg

String

参数解释

错误描述

取值范围

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及。

error_msg

String

参数解释

错误描述

取值范围

不涉及。

请求示例

查询实例ID为1f6305e9ac4443b8a79f1bfd3a523002in07的前10个数据库。

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

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

响应示例

状态码:200

Success.

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

状态码:400

Client error.

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档