Skip to main content

获取 Table 列表

根据数据库名称,或 Schema 名称(三层架构数据源)查询表列表。

请求地址:/openapi/v1/metadata/table/list

请求方法:GET

请求参数

参数类型是否必选说明示例
datasourceIdString数据源 ID。您可以调用获取数据源列表接口获取 datasourceIdds-d92qvqp8o1fw
databaseNameString数据库名称。您可以调用获取 Database 列表接口获取 databaseName9zcloud
schemaNameStringSchema 名称。您可以调用获取 Schema 列表接口获取 schemaNamepublic
currentInteger当前页码,从 1 开始,默认 1。1
pageSizeInteger分页大小,默认 10。10

返回参数

参数类型说明示例
successBool接口调用是否成功。返回值:turefalseture
requestIdString请求 ID。Ww2k2GVI-DJGGvSDnEJKv3PFdHIp6ETC
dataArrayTable 列表,包含 Table 名称(tableName)等信息。{
"tableName": "pgbench_accounts"
}, {
"tableName": "pgbench_branches"
}, {
"tableName": "pgbench_history"
}, {
"tableName": "pgbench_tellers"
}
currentInteger当前页码。1
pageSizeInteger每页的大小。10
totalIntegerTable 的总数。4

调用成功示例

{
"success": true,
"requestId": "Ww2k2GVI-DJGGvSDnEJKv3PFdHIp6ETC",
"data": [{
"tableName": "pgbench_accounts"
}, {
"tableName": "pgbench_branches"
}, {
"tableName": "pgbench_history"
}, {
"tableName": "pgbench_tellers"
}],
"current": 1,
"pageSize": 10,
"total": 4
}