查看数据库中的对象¶

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

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

调用前准备¶

先查询数据库列表取得目标数据库 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和数据库 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"'
  }'

参数说明

请求体

字段	类型	必填	说明
`id`	integer	是	数据库 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"]
      }
    ]
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。

查询结果

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`list`	object（对象数组）	子对象列表；无可读对象时为空数组。

数据库对象

下面表格展开响应示例中 data.list 数组的每一项；每一行是该数组项的一个字段。

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

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。
`data`	null	错误响应中的附加数据；本示例为 `null`。

后续操作¶

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

最后更新于 2026 年 9 月 3 日