查询数据库中的对象

查询指定数据库下可读取的卷、表和算子。

POST https://moi.matrixorigin.cn/newmoi/catalog/database/children

调用前准备

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

下方示例使用：

• $AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。

• $WORKSPACE_ID：目标工作区 ID，通过 X-Workspace-ID Header 传递。

• $DATABASE_ID：要查询子对象的数据库 ID。

请求体

参数	类型	是否必填	说明
id	integer	是	数据库 ID。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/catalog/database/children" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$DATABASE_ID"'
  }'

成功响应

成功时返回 200 和当前身份可读取的子对象列表。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "list": [
      {
        "id": 10,
        "name": "raw",
        "type": "volume",
        "children_count": 2,
        "size": 1024,
        "description": "原始文件",
        "reserved": false,
        "allowed_actions": ["volume.read"]
      }
    ]
  }
}

响应字段如下。

本文中，类型后的 [] 表示数组，例如 string[] 是字符串数组；字段路径中的 [] 表示数组中的每一项，例如 data.list[].id 表示 data.list 数组中每一项的 id 字段。

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.list	object（对象数组）	子对象列表；无可读对象时为空数组。
data.list[].id	integer 或 string	对象 ID。
data.list[].name	string	对象名称。
data.list[].type	string	对象类型：volume、table 或 function。
data.list[].children_count	integer	子项数量；适用时返回。
data.list[].size	integer	存储大小；适用时返回。
data.list[].created_at	string	创建时间；适用时返回。
data.list[].created_by	string	创建者标识；适用时返回。
data.list[].updated_at	string	更新时间；适用时返回。
data.list[].updated_by	string	更新者标识；适用时返回。
data.list[].description	string	对象说明。
data.list[].display_name	string	对象显示名称；适用时返回。
data.list[].display_description	string	对象显示说明；适用时返回。
data.list[].reserved	boolean	是否为保留对象。
data.list[].is_pub	boolean	是否为发布对象；适用时返回。
data.list[].is_sub	boolean	是否为订阅对象；适用时返回。
data.list[].allowed_actions	string（字符串数组）	当前身份允许的操作。

错误响应

{
  "code": "ErrObjectNotFound",
  "msg": "数据库不存在",
  "data": null
}

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	请求体或数据库 ID 无效。	使用数据库列表中的正整数 ID。
403	ErrForbidden	当前身份没有读取权限。	请求授予 database.read 权限。
404	ErrObjectNotFound	数据库不存在或不可读取。	核对数据库 ID 和工作区。
500	ErrServer	服务端未能读取子对象。	稍后重试。

后续操作

保存目标项的标识，再查询 Catalog 详情。

最后更新于 2026 年 8 月 22 日