# 查询 Catalog 详情

按 ID 查询一个 Catalog 的详情。

```text
POST https://moi.matrixorigin.cn/newmoi/catalog/info
```

## 调用前准备

先[查询 Catalog 列表](list-catalogs.md)取得目标 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。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/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"'
  }'
```

## 成功响应

成功时返回 `200` 和 Catalog 详情。

```json
{
  "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。 |
| `data.catalog.name` | string | Catalog 原始名称。 |
| `data.catalog.description` | string | Catalog 说明。 |
| `data.catalog.display_name` | string | Catalog 显示名称；有值时返回。 |
| `data.catalog.display_description` | string | Catalog 显示说明；有值时返回。 |

## 错误响应

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

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

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

## 后续操作

需要修改时[更新 Catalog](update-catalog.md)。返回列表时[查询文件产物](list-file-artifacts.md)。