查询系统数据库

查询系统数据库的只读导航树。

POST https://api.moi.matrixorigin.cn/v5/catalog/system/tree

调用前准备

准备可访问目标工作区的个人访问令牌和工作区 ID。

请求体

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/system/tree" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "include_table_leaves": false
  }'

参数说明

字段	类型	是否必填	说明
include_table_leaves	boolean	否	是否在树中包含表叶子节点。省略或为 null 时默认 true。

成功响应

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "tree": [
      {
        "type": "catalog",
        "name": "system",
        "node_list": []
      }
    ]
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.tree	object（对象数组）	系统库导航树。
data.tree[].id	string	节点 ID。
data.tree[].type	string	节点类型：catalog、database、volume 或 table。
data.tree[].name	string	节点名称。
data.tree[].description	string	节点说明。
data.tree[].reserved	boolean	是否为保留节点。
data.tree[].node_list	object（对象数组）	子节点，字段与父节点相同。可继续递归嵌套。
data.tree[].allowed_actions	string（字符串数组）	当前身份在该节点上允许的操作。

错误响应

响应示例

{
  "code": "ErrServer",
  "msg": "Internal Server Error"
}

字段说明

字段	类型	说明
code	string	错误代码。
msg	string	错误信息。

最后更新于 2026 年 10 月 19 日