取消数据订阅

取消一个已接受的数据订阅。成功后,目标工作区中的订阅数据库会被删除,订阅记录恢复为可重新接受的邀请。

POST https://moi.matrixorigin.cn/newmoi/data-share/subscriptions/{id}/unsubscribe

调用前准备

查询数据订阅列表,确认要取消的订阅。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和订阅 ID。

下方示例使用:

  • $AI_STUDIO_API_KEY:实际个人访问令牌,通过 X-API-Key Header 传递。

  • $WORKSPACE_ID:目标工作区 ID,通过 X-Workspace-ID Header 传递。

  • $SUBSCRIPTION_ID:要取消的订阅 ID,取自查询数据订阅列表的响应。

路径参数

参数

类型

说明

id

integer

大于 0 的订阅 ID。

请求示例

curl -X POST "https://moi.matrixorigin.cn/newmoi/data-share/subscriptions/$SUBSCRIPTION_ID/unsubscribe" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200datanull

{
  "code": "OK",
  "msg": "OK",
  "data": null
}

响应字段如下。

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

null

取消成功时固定为 null

错误响应

{
  "code": "ErrSubscriptionNotFound",
  "msg": "数据订阅不存在",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

ErrParamInvalid

id 不是大于 0 的整数。

使用订阅列表中的 ID。

403

ErrPermissionDenied

当前身份没有删除订阅的权限。

请求授予数据订阅删除权限。

404

ErrSubscriptionNotFound

订阅不存在或不属于当前工作区。

核对订阅 ID 和工作区。

409

ErrSubscriptionDeleteConflict

订阅状态已发生变化,当前不能取消。

刷新订阅列表后再试。

503

ErrDataShareWritesPaused

数据分享写入暂时处于维护或迁移门禁。

稍后重试。

500

ErrServer

服务端未能取消订阅。

稍后重试。

后续操作

查询数据订阅列表,确认该记录的状态已恢复为可重新接受的订阅邀请。

最后更新于