查看 Catalog 详情¶

按 ID 查询一个 Catalog 的详情。

POST https://api.moi.matrixorigin.cn/v5/catalog/info

调用前准备¶

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

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/info" \
  -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 和 Catalog 详情。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "catalog": {
      "id": 1,
      "name": "sales",
      "display_name": "sales",
      "description": "销售数据",
      "display_description": "销售数据"
    }
  }
}

字段说明

通用字段

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

资源目录信息

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

字段	类型	说明
`id`	integer	Catalog ID。
`name`	string	Catalog 原始名称。
`description`	string	Catalog 说明。
`display_name`	string	Catalog 显示名称；有值时返回。
`display_description`	string	Catalog 显示说明；有值时返回。

错误响应¶

响应示例

{
  "code": "ErrObjectNotFound",
  "msg": "Catalog 不存在",
  "data": null
}

字段说明

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

后续操作¶

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

最后更新于 2026 年 9 月 11 日