获取 Table 列表
根据数据库名称,或 Schema 名称(三层架构数据源)查询表列表。
请求地址:/openapi/v1/metadata/table/list
请求方法:GET
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| datasourceId | String | 是 | 数据源 ID。您可以调用获取数据源列表接口获取 datasourceId。 | ds-d92qvqp8o1fw |
| databaseName | String | 是 | 数据库名称。您可以调用获取 Database 列表接口获取 databaseName。 | 9zcloud |
| schemaName | String | 否 | Schema 名称。您可以调用获取 Schema 列表接口获取 schemaName。 | public |
| current | Integer | 否 | 当前页码,从 1 开始,默认 1。 | 1 |
| pageSize | Integer | 否 | 分页大小,默认 10。 | 10 |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Bool | 接口调用是否成功。返回值:ture、false。 | ture |
| requestId | String | 请求 ID。 | Ww2k2GVI-DJGGvSDnEJKv3PFdHIp6ETC |
| data | Array | Table 列表,包含 Table 名称(tableName)等信息。 | { "tableName": "pgbench_accounts" }, { "tableName": "pgbench_branches" }, { "tableName": "pgbench_history" }, { "tableName": "pgbench_tellers" } |
| current | Integer | 当前页码。 | 1 |
| pageSize | Integer | 每页的大小。 | 10 |
| total | Integer | Table 的总数。 | 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
}