校验连接器配置¶
校验一个尚未保存或已编辑的连接器定义。校验只检查当前连接信息,不会创建或更新连接器。
POST https://moi.matrixorigin.cn/newmoi/connectors/validate
调用前准备¶
请求体¶
将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的连接信息替换为实际值。
curl -X POST "https://moi.matrixorigin.cn/newmoi/connectors/validate" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
-d "{
\"source_type\": 5,
\"config\": {
\"s3\": {
\"endpoint\": \"$S3_ENDPOINT\",
\"access_key_id\": \"$S3_ACCESS_KEY_ID\",
\"access_key_secret\": \"$S3_ACCESS_KEY_SECRET\",
\"bucket_name\": \"$S3_BUCKET_NAME\",
\"region\": \"$S3_REGION\"
}
}
}"
参数 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
integer |
是 |
数据源类型代码。标准 S3 填写 |
|
object |
是 |
连接信息。只填写与 |
|
object |
是 |
标准 S3 的连接信息。 |
|
string |
否 |
S3 服务端点。 |
|
string |
是 |
访问密钥 ID。 |
|
string |
是 |
访问密钥。 |
|
string |
是 |
存储桶名称或路径前缀。 |
|
string |
否 |
存储桶所在区域。 |
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"valid": true
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 |
|
string |
成功时为 |
|
boolean |
当前连接定义是否通过校验。 |
错误响应¶
{
"code": "ErrParamInvalid",
"msg": "invalid connector parameters",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
错误代码。先检查该字段,再检查 |
|
string |
可读错误信息。 |
|
null |
错误响应中为 |
后续操作¶
data.valid 为 true 时,补充创建所需的 name 和 usage_type 后创建连接器。为 false 时,先修正 source_type 或 config 后再重新校验,不要直接创建。
最后更新于