查看订阅列表¶

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

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

调用前准备¶

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

请求参数¶

请求示例

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"

参数说明

参数

字段	类型	必填	说明
`keyword`	string	否	按关键字搜索。
`status`	string	否	按订阅状态筛选；可传 `unsubscribed`、`subscribing` 或 `subscribed`。
`page`	integer	否	页码；默认 `1`。
`page_size`	integer	否	每页数量；默认 `20`，最大 `100`。

成功响应¶

响应示例

{
  "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
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

分页信息

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

字段	类型	说明
`list`	array of object	当前页订阅列表；无结果时为空数组。
`total`	integer	匹配总数。
`page`	integer	当前页码。
`page_size`	integer	每页数量。

订阅信息

下面表格展开响应示例中 data.list 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`id`	string	订阅 ID。
`pub_name`	string	来源发布名称。
`source_database_id`	string	来源数据库 ID。
`mo_database_name`	string	来源数据库名称。
`table_scope`	object	发布共享的表范围。
`target_database_id`	string	目标工作区中订阅数据库的 ID；未接受时为空字符串。
`obj_display_name`	string	来源数据库的显示名称。
`obj_display_path`	string	来源数据库的显示路径。
`source_workspace_id`	string	来源工作区 ID。
`source_workspace_name`	string	来源工作区名称；有值时返回。
`publisher`	string	发布者。
`published_at`	string	发布时间。
`status`	string	当前订阅状态：`unsubscribed`、`subscribing` 或 `subscribed`。
`sub_name`	string	目标工作区中的订阅数据库名称；未接受时为空字符串。
`subscribed_by`	string	接受订阅的身份标识；未接受时为空字符串。
`created_at`	string	接受订阅的时间；未接受时为空字符串。

表范围

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

字段	类型	说明
`mode`	string	范围模式：`all` 或 `selected`。
`object_ids`	array of string	当范围模式为 `selected` 时的表 ID 列表。

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

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误说明。
`data`	null	错误时为空。

后续操作¶

使用 data.list[].id 接受数据订阅。

最后更新于 2026 年 9 月 3 日