探测已保存的 REST API 连接器¶
使用已保存连接器的配置和凭据,向来源发起验证请求。
POST https://api.moi.matrixorigin.cn/v5/connectors/{id}/rest-api/probe
调用前准备¶
准备目标工作区的个人访问令牌及连接器对应操作权限。草稿文件、来源端点与环境边界见公共说明。
请求示例¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/$CONNECTOR_ID/rest-api/probe" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID"
本动作不需要请求体,不能通过请求体临时覆盖保存的配置。连接器须 active、来源类型为 REST API 且具有导入用途,并已配置启用的验证端点。成功仅说明本次验证满足条件;它不是预览、任务创建或数据导入。来源 HTTP 和令牌端点仍可能被访问。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
路径必填 |
当前工作区已启用且支持导入的 REST API 连接器 ID。 |
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"valid": true
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 OK。 |
|
string |
响应信息。 |
|
object |
本次动作结果。 |
|
boolean |
成功时为 true,表示本次来源探测及所配成功条件通过。 |
错误响应¶
配置错误与来源执行失败分开处理。MOI 可将来源错误包装为 HTTP 502 ErrConnectorRESTRead;不要将信息中的来源 HTTP 状态当作本请求状态。详见错误与环境。
最后更新于