查看可浏览的连接器列表

查看当前工作区可用于浏览数据库的连接器及其能力。

GET https://moi.matrixorigin.cn/newmoi/connectors/structured/v1/sources

调用前准备

准备有目标工作区访问权限的个人访问令牌目标工作区 ID。仅选择响应中 enabled 为 true 且目标操作对应能力为 true 的连接器。

调用示例

$AI_STUDIO_API_KEY$WORKSPACE_ID 替换为实际值。

curl "https://moi.matrixorigin.cn/newmoi/connectors/structured/v1/sources" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

无请求参数。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "sources": [{
      "connector_id": "conn_01",
      "connector_name": "orders_mysql",
      "source_type": "SOURCE_TYPE_MYSQL",
      "enabled": true,
      "disabled_reason": "",
      "capability_profile_hash": "capability-profile-hash",
      "capabilities": {"list_databases": true, "list_schemas": false, "list_tables": true, "describe_schema": true, "sample": false, "backfill_start_resolve": false, "hive_partitions": false, "mongodb_flatten": false}
    }]
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

data.sources

array of object

可浏览连接器。

data.sources.connector_id

string

连接器 ID。

data.sources.connector_name

string

连接器名称。

data.sources.source_type

string

结构化来源类型。

data.sources.enabled

boolean

是否可继续浏览。

data.sources.disabled_reason

string

不可用原因。

data.sources.capability_profile_hash

string

能力配置标识。

data.sources.capabilities

object

可调用的发现能力。

data.sources.capabilities.list_databases

boolean

是否可查看数据库。

data.sources.capabilities.list_schemas

boolean

是否可查看 Schema。

data.sources.capabilities.list_tables

boolean

是否可查看表或集合。

data.sources.capabilities.describe_schema

boolean

是否可查看字段结构。

data.sources.capabilities.sample

boolean

是否支持来源数据采样。

data.sources.capabilities.backfill_start_resolve

boolean

是否可解析回填起点。

data.sources.capabilities.hive_partitions

boolean

是否支持查看 Hive 分区。

data.sources.capabilities.mongodb_flatten

boolean

是否支持 MongoDB 扁平化映射。

错误响应

{"code": "STRUCTURED_CONNECTOR_SERVICE_UNAVAILABLE", "msg": "service unavailable", "data": null}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中为 null

后续操作

复制同一条可用记录的 connector_idsource_type查看数据库列表

最后更新于