取消订阅

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

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

调用前准备

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

请求参数

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

字段

类型

必填

说明

id

integer

大于 0 的订阅 ID。

成功响应

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

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data

null

取消成功时固定为 null

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

错误说明。

data

null

错误时为空。

后续操作

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

最后更新于