# 查询数据订阅列表

列出当前工作区收到的数据订阅。

```text
GET https://moi.matrixorigin.cn/newmoi/data-share/subscriptions
```

## 调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：要查询的工作区 ID，通过 `X-Workspace-ID` Header 传递。

## 查询参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `keyword` | string | 否 | 按关键字搜索。 |
| `status` | string | 否 | 按订阅状态筛选。 |
| `page` | integer | 否 | 页码；默认 `1`。 |
| `page_size` | integer | 否 | 每页数量；默认 `20`，最大 `100`。 |

## 请求示例

```bash
curl "https://moi.matrixorigin.cn/newmoi/data-share/subscriptions?page=1&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

## 成功响应

成功时返回 `200`。`data.list` 是当前页，`data.total` 是匹配总数。

```json
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "list": [
      {
        "id": "201",
        "pub_name": "sales-share",
        "source_database_id": "101",
        "mo_database_name": "sales",
        "table_scope": {
          "mode": "selected",
          "object_ids": ["1001"]
        },
        "target_database_id": "",
        "obj_display_name": "sales",
        "obj_display_path": "catalog/sales",
        "source_workspace_id": "ws-001",
        "source_workspace_name": "数据工作区",
        "publisher": "user-001",
        "published_at": "2026-08-18T10:00:00Z",
        "status": "unsubscribed",
        "sub_name": "",
        "subscribed_by": "",
        "created_at": "2026-08-18T10:00:00Z"
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20
  }
}
```

响应字段如下。

本文中，类型后的 `[]` 表示数组，例如 `string[]` 是字符串数组；字段路径中的 `[]` 表示数组中的每一项，例如 `data.list[].id` 表示 `data.list` 数组中每一项的 `id` 字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | string | 成功时为 `OK`。 |
| `msg` | string | 成功时为 `OK`。 |
| `data.list` | object（对象数组） | 当前页订阅列表；无结果时为空数组。 |
| `data.total` | integer | 匹配总数。 |
| `data.page` | integer | 当前页码。 |
| `data.page_size` | integer | 每页数量。 |
| `data.list[].id` | string | 订阅 ID。 |
| `data.list[].pub_name` | string | 来源发布名称。 |
| `data.list[].source_database_id` | string | 来源数据库 ID。 |
| `data.list[].mo_database_name` | string | 来源数据库名称。 |
| `data.list[].table_scope` | object | 发布共享的表范围。 |
| `data.list[].table_scope.mode` | string | 范围模式：`all` 或 `selected`。 |
| `data.list[].table_scope.object_ids` | string（字符串数组） | 当范围模式为 `selected` 时的表 ID 列表。 |
| `data.list[].target_database_id` | string | 目标工作区中订阅数据库的 ID；未接受时为空字符串。 |
| `data.list[].obj_display_name` | string | 来源数据库的显示名称。 |
| `data.list[].obj_display_path` | string | 来源数据库的显示路径。 |
| `data.list[].source_workspace_id` | string | 来源工作区 ID。 |
| `data.list[].source_workspace_name` | string | 来源工作区名称；有值时返回。 |
| `data.list[].publisher` | string | 发布者。 |
| `data.list[].published_at` | string | 发布时间。 |
| `data.list[].status` | string | 当前订阅状态。 |
| `data.list[].sub_name` | string | 目标工作区中的订阅数据库名称；未接受时为空字符串。 |
| `data.list[].subscribed_by` | string | 接受订阅的身份标识；未接受时为空字符串。 |
| `data.list[].created_at` | string | 接受订阅的时间；未接受时为空字符串。 |

## 错误响应

```json
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `ErrParamInvalid`
  - 分页或筛选参数无法解析。
  - 检查 `page`、`page_size`、`status` 和 `keyword`。
* - `403`
  - `ErrPermissionDenied`
  - 当前身份没有读取订阅的权限。
  - 请求授予数据订阅读取权限。
* - `503`
  - `ErrServiceUnavailable`
  - 依赖服务暂不可用。
  - 稍后重试。
* - `500`
  - `ErrServer`
  - 服务端未能读取订阅列表。
  - 稍后重试。
```

## 后续操作

使用 `data.list[].id` [接受数据订阅](accept-subscription.md)。