查询数据库列表

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

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

调用前准备

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

下方示例使用：

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

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

• $CATALOG_ID：要列出数据库的 Catalog ID。

请求体

参数	类型	是否必填	说明
id	integer	是	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"'
  }'

成功响应

成功时返回 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"]
      }
    ]
  }
}

响应字段如下。

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

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

错误响应

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

常见 HTTP 错误

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

后续操作

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

最后更新于 2026 年 8 月 22 日