查看数据库列表¶

返回指定 Catalog 下可读取的数据库列表。

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

调用前准备¶

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

请求体¶

请求示例

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

参数说明

请求体

字段	类型	必填	说明
`id`	integer	是	Catalog ID。

成功响应¶

成功时返回 200 和当前身份可读取的数据库列表。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "list": [
      {
        "id": 2,
        "name": "orders",
        "description": "订单库",
        "volume_count": 1,
        "file_count": 2,
        "table_count": 3,
        "created_at": "2026-08-18T10:00:00Z",
        "updated_at": "2026-08-18T10:00:00Z",
        "created_by": "user-001",
        "updated_by": "user-001",
        "reserved": false,
        "allowed_actions": ["database.read"]
      }
    ]
  }
}

字段说明

通用字段

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

查询结果

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

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

数据库

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

字段	类型	说明
`id`	integer	数据库 ID。
`name`	string	数据库名称。
`description`	string	数据库说明。
`display_name`	string	数据库显示名称；有值时返回。
`display_description`	string	数据库显示说明；有值时返回。
`volume_count`	integer	下属卷数量。
`file_count`	integer	下属文件数量。
`table_count`	integer	下属表数量。
`created_at`	string	创建时间。
`updated_at`	string	更新时间。
`created_by`	string	创建者标识。
`updated_by`	string	更新者标识。
`reserved`	boolean	是否为保留数据库。
`is_pub`	boolean	是否为已发布数据库。
`is_sub`	boolean	是否为已订阅数据库。
`allowed_actions`	string（字符串数组）	当前身份允许的操作。

错误响应¶

响应示例

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

字段说明

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

后续操作¶

使用 data.list[].id 查询数据库详情。

最后更新于 2026 年 9 月 3 日