# 查询 Catalog 引用

返回 Catalog 引用查询的当前结果。

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

## 调用前准备

先[查询 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/ref_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`。当前实现返回空数组，不能用该结果确认 Catalog 没有引用；删除操作的实际结果以删除接口响应为准。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "list": []
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.list` | object（对象数组） | 当前固定为空数组，不能用于判断是否存在引用。 |

## 错误响应

```json
{
  "code": "ErrServer",
  "msg": "服务器内部错误",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 请求体或 Catalog ID 无效。
  - 使用列表返回的正整数 ID。
* - `403`
  - `ErrForbidden`
  - 当前身份没有读取权限。
  - 请求授予 `catalog.read` 权限。
* - `500`
  - `ErrServer`
  - 服务端未能查询引用。
  - 稍后重试。
```

## 后续操作

需要删除 Catalog 时，直接调用[删除 Catalog](delete-catalog.md)并根据其响应处理结果。