探测未保存的 REST API 配置¶
使用草稿配置向来源发起验证请求,检查连接与验证条件。
POST https://api.moi.matrixorigin.cn/v5/connectors/rest-api/probe
调用前准备¶
准备目标工作区的个人访问令牌及连接器对应操作权限。草稿文件、来源端点与环境边界见公共说明。
请求体¶
jq -n --slurpfile config "$REST_CONFIG_JSON" '{config:$config[0]}' > request.json
curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/rest-api/probe" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary @request.json
示例使用文件中的原始配置对象构造请求。不会创建或修改连接器,但会执行对外 HTTP 请求;若使用 OAuth2,也可能先访问令牌端点。探测允许 GET 或 POST;POST 可能产生来源副作用,先确认所选验证端点。请求体受 1 MiB 读取上限约束。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
object |
是 |
含 rest_api 的连接器配置 JSON 对象,不是 JSON 字符串;从本地配置文件读取。 |
|
object |
是 |
连接、认证和探测配置,见公共说明。 |
|
boolean |
是 |
此动作要求 true;关闭验证端点不能执行探测。 |
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"valid": true
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 OK。 |
|
string |
响应信息。 |
|
object |
本次动作结果。 |
|
boolean |
成功时为 true,表示本次来源探测及所配成功条件通过。 |
错误响应¶
配置错误与来源执行失败分开处理。MOI 可将来源错误包装为 HTTP 502 ErrConnectorRESTRead;不要将信息中的来源 HTTP 状态当作本请求状态。详见错误与环境。
最后更新于