---
orphan: true
---

# 查询表引用

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

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

```text
POST https://api.moi.matrixorigin.cn/v5/catalog/table/ref_list
```

## 调用前准备

先[查询数据库中的对象](list-database-objects.md)取得目标表 ID。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和表 ID。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 请求示例

```bash
curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/table/ref_list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "id": '"$TABLE_ID"'
  }'
```

:::::
:::::{tab-item} 参数说明

::::{tab-set}
:::{tab-item} 请求体

| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `id` | integer | 是 | 表 ID。 |

:::
::::

:::::
::::::
:::::::

## 成功响应

成功时返回 `200`。当前实现返回空数组，不能用该结果确认表没有引用；删除操作的实际结果以删除接口响应为准。

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

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

:::::
:::::{tab-item} 字段说明

::::{tab-set}
:::{tab-item} 通用字段

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

:::
:::{tab-item} 引用结果

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `list` | array | 当前固定为空数组，不能用于判断是否存在引用。 |

:::
::::

:::::
::::::
:::::::

## 错误响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": "ErrParamInvalid",
  "msg": "id 无效",
  "data": null
}
```

:::::
:::::{tab-item} 字段说明

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

:::::
::::::
:::::::

## 后续操作

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