文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据库脱敏/ 获取数据库表列表 - ListTables
更新时间:2026-11-13 GMT+08:00
分享

获取数据库表列表 - ListTables

功能介绍

获取数据库表列表

调用方法

请参见如何调用API。

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/server/mask/dbs/rdbs/tables

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

参数解释:

数据库类型,用于指定要查询表列表的数据库类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of RdbTableResponseBody objects

参数解释:

数据库表列表,数组元素为RdbTableResponseBody对象

取值范围:

不涉及

表5 RdbTableResponseBody

参数

参数类型

描述

ins_id

String

参数解释:

实例ID

取值范围:

不涉及

ins_name

String

参数解释:

实例名称

取值范围:

不涉及

ins_type

String

参数解释:

实例类型

取值范围:

不涉及

kerberos_enabled

Boolean

参数解释:

是否启用Kerberos

取值范围:

不涉及

db_list

Array of DbList objects

参数解释:

数据库列表,数组中的每个元素为DbList对象,包含数据库ID、数据库名称和该数据库下的表列表信息

取值范围:

不涉及

表6 DbList

参数

参数类型

描述

db_id

String

参数解释:

数据库ID

取值范围:

不涉及

db_name

String

参数解释:

数据库名称

取值范围:

不涉及

tables

Array of strings

参数解释:

表列表,数组中的每个元素为表名称字符串,表示数据库下的具体表。当type为MYSQL/MRS_HIVE/Hive/ORACLE/TDSQL/DLI/HIVE_ONLY/DMDBMS时返回本字段。

取值范围:

不涉及

schema_list

Array of RdbTableSchemaList objects

参数解释:

schema列表,数组中的每个元素为SchemaList对象,包含schema名称及该schema下的表列表。当type为PG/GREENPLUM/DWS/MSSQL/KINGBASE/OPENGAUSS/HBASE时返回本字段。

取值范围:

不涉及

表7 RdbTableSchemaList

参数

参数类型

描述

schema_name

String

参数解释:

schema名称

取值范围:

不涉及

tables

Array of strings

参数解释:

表列表,数组中的每个元素为表名称字符串,表示schema下的具体表

取值范围:

不涉及

请求示例

获取数据库表列表

/v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/dbs/rdbs/tables?type=DB

响应示例

状态码:200

[ {
  "ins_id" : "00000000-0000-0000-0000-000000000000",
  "ins_name" : "实例1",
  "ins_type" : "rds",
  "kerberos_enabled" : false,
  "db_list" : [ {
    "db_id" : "00000000-0000-0000-0000-000000000000",
    "db_name" : "数据库1",
    "tables" : [ "table1" ]
  } ]
} ]

状态码

状态码

描述

200

查询成功。整个响应体为JSON数组,数组元素为RdbTableResponseBody。db_list元素字段随type参数变化:

  • MYSQL/MRS_HIVE/Hive/ORACLE/TDSQL/DLI/HIVE_ONLY/DMDBMS → db_list元素含tables字段

  • PG/GREENPLUM/DWS/MSSQL/KINGBASE/OPENGAUSS/HBASE → db_list元素含schema_list字段

错误码

请参见错误码。

相关文档