文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ HTAP-标准版/ 查询HTAP主实例数据库表列表- ShowInstanceTablesForHtap
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询HTAP主实例数据库表列表 - ShowInstanceTablesForHtap

功能介绍

查询HTAP主实例数据表列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:htapInstance:listDatabases

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:htapInstance:list

    -

URI

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

表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值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

Content-Type

是

String

参数解释：

内容类型。

约束限制：

不涉及。

取值范围：

application/json。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us
  • zh-cn

默认取值：

en-us。
表4 请求Body参数

参数

是否必选

参数类型

描述

database_tables

否

Array of DatabaseTablesInfo objects

参数解释：

需要检索的主实例的数据库及表名称的列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

source_instance_id

否

String

参数解释：

需要检索数据库的主实例ID，严格匹配UUID规则。

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

selected_tables

否

Array of DatabaseTablesInfo objects

参数解释：

已选择的数据库及表名称的列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

filter_type

否

String

参数解释：

表黑白名单设置。

约束限制：

不涉及。

取值范围：

  • include_tables：白名单。
  • exclude_tables：黑名单。

默认取值：

不涉及。
表5 DatabaseTablesInfo

参数

是否必选

参数类型

描述

database

否

String

参数解释：

查询的数据库名称。

约束限制：

支持英文大小写字母、数字、下划线。

取值范围：

不涉及。

默认取值：

不涉及。

tables

否

Array of strings

参数解释：

查询的数据表名称。

约束限制：

支持英文大小写字母、数字、下划线。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

tables

Array of strings

参数解释：

数据库表名称。

默认取值：

不涉及。

total_count

Integer

参数解释：

数据库数量。

默认取值：

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述

取值范围：

不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述

取值范围：

不涉及。

请求示例

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

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

{
  "database_tables" : [ {
    "database" : "sdk_test_db",
    "tables" : [ "sdk_table_01" ]
  } ],
  "selected_tables" : [ {
    "database" : "sdk_test_db",
    "tables" : [ "sdk_table_01" ]
  } ],
  "source_instance_id" : "95fcf0a93a954354acb16a27de121155in07",
  "filter_type" : "include_tables"
}

响应示例

状态码：200

Success.

{
  "tables" : [ "test_table1", "test_table2", "test_table3", "test_table4", "test_table5", "test_table6" ],
  "total_count" : 6
}

状态码：400

Client error.

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

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版