更新插件账号连接状态¶
启用或禁用已有插件账号连接。
PATCH https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-connections/{connection_id}
调用前准备¶
准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 workspace_id、connection_id 使用相应资源的实际标识。工作区 ID 同时填入 X-Workspace-ID。示例使用 jq 构造 JSON,运行前安装。环境变量的来源见公共对象与输入。
请求体¶
curl -X PATCH "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-connections/$CONNECTION_ID" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary "$(jq -n --argjson CONNECTION_VERSION "$CONNECTION_VERSION" '
{
"expected_version": $CONNECTION_VERSION,
"status": "disabled"
}
')"
先读取当前连接。此动作仅修改启用状态,不修改名称、发布、资源地址或凭据。成功后保存新 version;授权代次可能同时改变,需重新读取授权状态。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
当前连接或安装的 version,必须大于 0。 |
|
string |
是 |
active 或 disabled;与当前状态相同会产生状态冲突。 |
JSON 对象不接受未知字段、重复键或多个连续对象;总请求体不超过 1 MiB。
成功响应¶
{
"code": 0,
"data": {
"id": "connection_example",
"workspace_id": "workspace_example",
"name": "provider · connection_example",
"description": "我的插件账号",
"status": "disabled",
"kind": "plugin",
"endpoint_uri": "https://service.example.invalid",
"auth_type": "oauth2",
"visibility": "private",
"version": 2,
"created_at": "2026-11-11T00:00:00Z",
"updated_at": "2026-11-11T00:00:00Z"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
integer |
成功时为 0。 |
|
object |
当前动作返回的数据。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
当前状态;按本页条件及公共对象判断。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
|
integer |
当前资源版本,写入时作为 expected_version。 |
|
string |
资源字段,详见公共对象与状态。 |
|
string |
资源字段,详见公共对象与状态。 |
错误响应¶
业务错误的数字 code、message 和 details.reason 以及授权层错误的字符串代码分别处理,见错误与状态。遇到状态或版本冲突时先读取当前资源,不自动更换标识或重试写入。