校验连接器配置

校验一个尚未保存或已编辑的连接器定义。校验只检查当前连接信息,不会创建或更新连接器。

POST https://moi.matrixorigin.cn/newmoi/connectors/validate

调用前准备

准备与创建连接器接口相同的连接器定义、有目标工作区访问权限的个人访问令牌目标工作区 ID

请求体

$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\"
      }
    }
  }"

参数

类型

是否必填

说明

source_type

integer

数据源类型代码。标准 S3 填写 5,配置写在 config.s3

config

object

连接信息。只填写与 source_type 对应的一组配置。

config.s3

object

标准 S3 的连接信息。

config.s3.endpoint

string

S3 服务端点。

config.s3.access_key_id

string

访问密钥 ID。

config.s3.access_key_secret

string

访问密钥。

config.s3.bucket_name

string

存储桶名称或路径前缀。

config.s3.region

string

存储桶所在区域。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "valid": true
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.valid

boolean

当前连接定义是否通过校验。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "invalid connector parameters",
  "data": null
}

字段

类型

说明

code

string

错误代码。先检查该字段,再检查 data.valid

msg

string

可读错误信息。

data

null

错误响应中为 null

后续操作

data.valid 为 true 时,补充创建所需的 name 和 usage_type 后创建连接器。为 false 时,先修正 source_type 或 config 后再重新校验,不要直接创建。

最后更新于