查询插件账号授权状态

读取插件账号的授权状态、连接版本与授权代次。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-connections/{connection_id}/authorization

调用前准备

准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 workspace_id、connection_id 使用相应资源的实际标识。工作区 ID 同时填入 X-Workspace-ID。环境变量的来源见公共对象与输入。

路径参数

curl -X GET "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-connections/$CONNECTION_ID/authorization" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

连接状态 active 不等于账号已授权。没有授权记录时返回 not_connected;此时 generation/revision 为 0。attempt_id 并非所有授权方式都返回,保留授权动作中取得的非空尝试 ID。

此动作不接收请求体。

成功响应

{
  "code": 0,
  "data": {
    "workspace_id": "workspace_example",
    "connection_id": "connection_example",
    "status": "not_connected",
    "generation": 0,
    "revision": 0,
    "connection_version": 1
  }
}

字段

类型

说明

code

integer

成功时为 0。

data

object

当前动作返回的数据。

data.workspace_id

string

资源字段,详见公共对象与状态。

data.connection_id

string

资源字段,详见公共对象与状态。

data.status

string

当前状态;按本页条件及公共对象判断。

data.generation

integer

授权代次,断开时作为 expected_generation;未授权时可能为 0。

data.revision

integer

资源字段,详见公共对象与状态。

data.connection_version

integer

资源字段,详见公共对象与状态。

错误响应

业务错误的数字 code、message 和 details.reason 以及授权层错误的字符串代码分别处理,见错误与状态。遇到状态或版本冲突时先读取当前资源,不自动更换标识或重试写入。

最后更新于