接受订阅¶

接受一条数据订阅，并指定目标工作区中的订阅数据库名称。

POST https://api.moi.matrixorigin.cn/v5/data-share/subscriptions/{id}/subscribe

调用前准备¶

先查询数据订阅列表，确认要接受的订阅。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID、订阅 ID 和本地订阅名称。

请求体¶

请求示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/data-share/subscriptions/$SUBSCRIPTION_ID/subscribe" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "sub_name": "sales_subscription"
  }'

参数说明

路径参数

字段	类型	必填	说明
`id`	integer	是	大于 `0` 的订阅 ID。

请求体

字段	类型	必填	说明
`sub_name`	string	是	本地订阅名称。

成功响应¶

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": "201",
    "pub_name": "sales-share",
    "source_database_id": "101",
    "mo_database_name": "sales",
    "table_scope": {
      "mode": "selected",
      "object_ids": ["1001"]
    },
    "target_database_id": "301",
    "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": "subscribed",
    "sub_name": "sales_subscription",
    "subscribed_by": "user-002",
    "created_at": "2026-08-18T10:00:00Z"
  }
}

字段说明

通用字段

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

订阅信息

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

字段	类型	说明
`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.table_scope 对象；每一行是该对象的一个字段。

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

错误响应¶

响应示例

{
  "code": "ErrAlreadySubscribed",
  "msg": "数据已订阅",
  "data": null
}

字段说明

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

后续操作¶

使用 data.target_database_id 记录目标订阅数据库；再查询数据订阅列表确认订阅状态和名称。

最后更新于 2026 年 9 月 28 日