获取 Schema 列表
根据数据源 ID、数据库名称查询数据库的 Schema 列表。仅适用于有三层结构的数据源,例如 SQL Server、PostgreSQL 等。
请求地址:/openapi/v1/metadata/schema/list
请求方法:GET
请求参数
| 参数 | 类型 | 是否必选 | 说明 | 示例 |
|---|---|---|---|---|
| datasourceId | String | 是 | 数据源 ID。您可以调用获取数据源列表接口获取 datasourceId。 | ds-d92qvqp8o1fw |
| databaseName | String | 是 | 数据库名称。您可以调用获取数据库列表接口获取 databaseName。 | 9zcloud |
| current | Integer | 否 | 当前页码,从 1 开始,默认 1。 | 1 |
| pageSize | Integer | 否 | 分页大小,默认 10。 | 10 |
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Bool | 接口调用是否成功。返回值:ture、false。 | ture |
| requestId | String | 请求 ID。 | Ci8z3CJA-EKHHvMPnFKLq2XPdDFn7VWQ |
| data | Array | Schema 列表,包含 Schema 名称(schemaName)等信息。 | { "schemaName": "ninedata" }, { "schemaName": "public" } |
| current | Integer | 当前页码。 | 1 |
| pageSize | Integer | 每页的大小。 | 10 |
| total | Integer | Schema 总数。 | 2 |
调用成功示例
{
"success": true,
"requestId": "Ci8z3CJA-EKHHvMPnFKLq2XPdDFn7VWQ",
"data": [{
"schemaName": "ninedata"
}, {
"schemaName": "public"
}],
"current": 1,
"pageSize": 10,
"total": 2
}