Skip to main content

获取 Schema 列表

根据数据源 ID、数据库名称查询数据库的 Schema 列表。仅适用于有三层结构的数据源,例如 SQL Server、PostgreSQL 等。

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

请求方法:GET

请求参数

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

返回参数

参数类型说明示例
successBool接口调用是否成功。返回值:turefalseture
requestIdString请求 ID。Ci8z3CJA-EKHHvMPnFKLq2XPdDFn7VWQ
dataArraySchema 列表,包含 Schema 名称(schemaName)等信息。{
"schemaName": "ninedata"
}, {
"schemaName": "public"
}
currentInteger当前页码。1
pageSizeInteger每页的大小。10
totalIntegerSchema 总数。2

调用成功示例

{
"success": true,
"requestId": "Ci8z3CJA-EKHHvMPnFKLq2XPdDFn7VWQ",
"data": [{
"schemaName": "ninedata"
}, {
"schemaName": "public"
}],
"current": 1,
"pageSize": 10,
"total": 2
}