查询数据库详情¶

按 ID 查询数据库详情。

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

调用前准备¶

先查询数据库列表取得目标数据库 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/info" \
  -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": {
    "database": {
      "id": 2,
      "name": "orders",
      "display_name": "orders",
      "description": "订单库",
      "display_description": "订单库"
    }
  }
}

响应字段如下。

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.database.id`	integer	数据库 ID。
`data.database.name`	string	数据库原始名称。
`data.database.description`	string	数据库说明。
`data.database.display_name`	string	数据库显示名称；有值时返回。
`data.database.display_description`	string	数据库显示说明；有值时返回。

错误响应¶

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

常见 HTTP 错误¶

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

后续操作¶

需要修改时更新数据库。返回列表时查询文件产物。

最后更新于 2026 年 8 月 22 日