删除连接器

删除一个已保存的连接器。删除后无法恢复,且不会删除此前通过该连接器写入的数据。

DELETE https://moi.matrixorigin.cn/newmoi/connectors/{connector_id}

调用前准备

查询连接器详情,检查 related_task_ids。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和连接器 ID。

下方示例使用:

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

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

  • $CONNECTOR_ID:要删除的连接器 ID。

如果连接器仍被未完成的导入任务使用,删除请求会被拒绝。先处理这些任务。

路径参数

参数

类型

说明

connector_id

string

要删除的连接器 ID。

请求示例

curl -X DELETE "https://moi.matrixorigin.cn/newmoi/connectors/$CONNECTOR_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

当响应中的 codeOK 时,删除请求已被接受,datanull。该接口不返回已删除对象;通过列表确认连接器不再出现后,删除不可恢复。

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

响应字段如下。

字段

类型

说明

code

string

OK 表示删除请求已被接受。

msg

string

删除请求的处理说明。

data

null

该接口不返回已删除对象。

错误响应

HTTP 200 不一定表示删除请求被接受。始终检查响应中的 code;只有 code: "OK" 才表示接口已接受删除请求。

{
  "code": "ErrConnectorInUse",
  "msg": "connector is in use",
  "data": null
}

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

409

ErrConnectorInUse

连接器仍被未完成的导入任务使用。

先停止、迁移或删除关联任务。

200

ErrServer

服务未能删除连接器。

检查 code;此时连接器未删除,可稍后重试。

503

ErrServer

服务暂时无法完成删除。

稍后重试。

后续操作

查询连接器列表确认该连接器已不再出现。删除接口不返回资源对象,详情查询结果不能替代该确认。

最后更新于