查看字段结构¶

读取所选来源对象的字段结构和映射参考。

POST https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/schema

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。依次从查看可浏览的连接器列表、查看数据库列表、查看 Schema 列表（如适用）和查看表和集合列表取得同一个来源对象的标识。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的来源对象标识替换为实际值。

输入示例

关系型表

curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/schema" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d @- <<EOF
{
  "connector_id": "$CONNECTOR_ID",
  "source": {
    "connector_id": "$CONNECTOR_ID",
    "source_type": "$SOURCE_TYPE",
    "database": "$DATABASE",
    "schema": "$SCHEMA",
    "table": "$TABLE"
  }
}
EOF

MongoDB 集合

curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/schema" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d @- <<EOF
{
  "connector_id": "$CONNECTOR_ID",
  "source": {
    "connector_id": "$CONNECTOR_ID",
    "source_type": "SOURCE_TYPE_MONGODB",
    "database": "$DATABASE",
    "collection": "$COLLECTION"
  },
  "mongo_sample_limit": 1000
}
EOF

参数说明

关系型表

参数	类型	是否必填	说明
`connector_id`	string	是	连接器 ID。
`source`	object	是	来源对象。
`source.connector_id`	string	是	与顶层连接器 ID 相同。
`source.source_type`	string	是	来源类型。
`source.database`	string	是	数据库名称。
`source.schema`	string	否	Schema 名称。
`source.table`	string	是	表名称。

MongoDB 集合

参数	类型	是否必填	说明
`connector_id`	string	是	连接器 ID。
`source`	object	是	MongoDB 来源对象。
`source.connector_id`	string	是	与顶层连接器 ID 相同。
`source.source_type`	string	是	MongoDB 来源类型。
`source.database`	string	是	数据库名称。
`source.collection`	string	是	集合名称。
`mongo_sample_limit`	integer	否	用于推断字段结构的采样上限。

成功响应¶

响应示例

{"code": "OK", "msg": "OK", "data": {"schema_snapshot": {"fields": [{"name": "id", "type": "bigint"}]}, "mapping_draft": [], "target_type_catalog": [], "field_compatibilities": [], "source_schema_hash": "schema-hash", "source_object_hash": "object-hash", "connector_config_hash": "connector-hash", "mapping_hash": "mapping-hash", "flatten_hash": "flatten-hash", "endpoint_results": []}}

字段说明

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data.schema_snapshot`	JSON	来源字段结构。
`data.mapping_draft`	JSON	候选映射。
`data.target_type_catalog`	JSON	目标类型目录。
`data.field_compatibilities`	JSON	字段兼容性参考。
`data.source_schema_hash`	string	字段结构标识。
`data.source_object_hash`	string	来源对象标识。
`data.connector_config_hash`	string	连接器配置标识。
`data.mapping_hash`	string	映射参考标识。
`data.flatten_hash`	string	扁平化参考标识。
`data.endpoint_results`	array of JSON	预留结果集。

错误响应¶

响应示例

{"code": "ErrParamInvalid", "msg": "invalid parameter", "data": null}

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误信息。
`data`	null	错误响应中为 `null`。

后续操作¶

使用 data.schema_snapshot、映射参考和摘要标识配置后续结构化导入；该响应本身不包含创建导入任务需要的一致性证明。

最后更新于 2026 年 9 月 6 日