文档首页/云数据库 GaussDB/API参考/API（推荐）/管理数据库和用户/查询数据库表列表 - QueryingDatabaseTables
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询数据库表列表 - QueryingDatabaseTables

功能介绍

查询指定实例的数据库表列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/tables

表1 参数说明

名称

是否必选

参数类型

说明

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db_name

是

String

参数解释：

数据库名称。

约束限制：

不能使用模板库，且是已存在的数据库名称。

模板库包括postgres， template0，template1，templatea，template_pdb，templatem。

取值范围：

不涉及。

默认取值：

不涉及。

schema_name

是

String

参数解释：

SCHEMA名称。

约束限制：

不能使用public，information_schema，且schema名称必须存在。

取值范围：

不涉及。

默认取值：

不涉及。

table_name_keyword

否

String

参数解释：

表名关键字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量，表示从此偏移量开始查询。

约束限制：

不涉及。

取值范围：

[0~2147483647)

默认取值：

0。

limit

否

Integer

参数解释：

每页显示的条目数量。

约束限制：

不涉及。

取值范围：

[1, 200]

默认取值：

10

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表3 响应Body参数列表

名称

参数类型

说明

database_tables

Array of objects

参数解释：

列表中每个元素表示一个数据库表，详情参见表4。

total_count

Integer

参数解释：

数据库表总数。

取值范围：

[0~2147483647)

表4 DatabaseForListTable

名称

参数类型

说明

table_name

String

参数解释：

表名称。

取值范围：

不涉及。

请求示例

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/a7d62bf77aa04fceb52fbd57181c9e3ein14/tables?db_name=rds_test&schema_name=rds_test&offset=1&limit=10

响应示例

{
  "database_tables" : [ 
  {
    "table_name" : "rds-test"
  }, 
  {
    "table_name" : "testdb1"
   } ],
  "total_count" : 2
}

状态码

错误码

请参见错误码。