查询数据库中的表

分页查询指定数据库直接包含的表。

POST https://api.moi.matrixorigin.cn/v5/catalog/database/table-leaves

调用前准备

先查询数据库列表取得数据库 ID。准备可访问目标工作区的个人访问令牌、目标工作区 ID 和数据库 ID。

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/database/table-leaves" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "database_id": '"$DATABASE_ID"',
    "page_size": 20
  }'

字段

类型

是否必填

说明

database_id

integer

是

数据库 ID，必须为正整数。

page_size

integer

否

每页条数。小于等于 0 时使用 50，大于 100 时使用 100。

page_token

string

否

偏移量的十进制字符串。去除首尾空白后解析为非负整数。首次调用可省略，后续使用返回的 next_page_token。

search

string

否

移除首尾空白后，匹配包含搜索文本的名称。不区分大小写。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "table_id": 101,
        "table_name": "orders",
        "database_id": 10,
        "created_at": "2026-08-01T09:00:00Z",
        "updated_at": "2026-08-01T09:00:00Z"
      }
    ],
    "total": 1
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.items

object（对象数组）

当前页表列表。

data.total

integer

匹配的表总数。

data.next_page_token

string

可选。下一页分页标记。没有下一页时该字段可能省略。

data.items[].table_id

integer

表 ID。

data.items[].table_name

string

表名称。

data.items[].database_id

integer

所属数据库 ID。

data.items[].created_at

string

创建时间。

data.items[].updated_at

string

更新时间。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效"
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。
最后更新于