查询结构化来源读取能力¶
查询指定 MySQL 或 Doris 表的当前读取与 CDC 能力。
POST https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/capabilities
调用前准备¶
准备目标工作区的个人访问令牌及相应来源读取或导入运行权限,安装 jq 并设置示例变量。身份、环境和结果交接见公共说明。
请求体¶
curl -X POST "https://api.moi.matrixorigin.cn/v5/connectors/structured/v1/source/capabilities" \
-H "X-API-Key: $AI_STUDIO_API_KEY" \
-H "X-Workspace-ID: $WORKSPACE_ID" \
-H 'Content-Type: application/json' \
--data-binary "$(jq -n --arg v0 "$CONNECTOR_ID" --arg v1 "$CONNECTOR_ID" --arg v2 "$SOURCE_DATABASE" --arg v3 "$SOURCE_TABLE" '{"connector_id":$v0,"source":{"connector_id":$v1,"source_type":"SOURCE_TYPE_DORIS","database":$v2,"table":$v3}}')"
source_type 仅为 SOURCE_TYPE_MYSQL 或 SOURCE_TYPE_DORIS,且须与连接器实际类型一致。MySQL 与 Doris 的能力受当前部署、Worker 和来源配置约束,不从类型名推定可用。disabled_reasons 仅保留 MYSQL_CDC_ 与 DORIS_CDC_ 原因;Doris 来源读取原因另在 doris_read_disabled_reasons,不能据 CDC 可用断定读取方式都可用。
字段 |
类型 |
是否必填 |
说明 |
|---|---|---|---|
|
string |
是 |
当前工作区已启用且支持导入的连接器 ID。 |
|
object |
是 |
同一连接器的来源对象。 |
|
string |
是 |
与外层 connector_id 一致。 |
|
string |
是 |
当前动作允许的 API 大写枚举;不是 Worker 的小写名称。 |
|
string |
是 |
来源数据库。 |
|
string |
是 |
来源表。 |
|
string |
否 |
来源要求时提供。 |
成功响应¶
{
"code": "OK",
"msg": "OK",
"data": {
"capability_profile_hash": "profile-example",
"mysql_cdc_available": false,
"doris_cdc_available": true,
"disabled_reasons": [],
"doris_flight_sql_read_available": true,
"doris_thrift_read_available": false,
"doris_jdbc_read_available": true,
"doris_read_mode": "flight_sql",
"doris_read_disabled_reasons": null
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
成功时为 OK;还须检查 HTTP 与业务代码。 |
|
string |
响应信息。 |
|
object |
当前来源结果。 |
|
string |
当前能力快照摘要,不是永久授权或部署版本。 |
|
boolean |
MySQL CDC 当前是否可用。 |
|
boolean |
Doris CDC 当前是否可用。 |
|
string[] |
当前 CDC 禁用原因。 |
|
boolean |
Flight SQL 读取当前是否可用。 |
|
boolean |
Thrift 读取当前是否可用。 |
|
boolean |
JDBC 读取当前是否可用。 |
|
string |
当前选择的 Doris 读取方式。 |
|
string[] 或 null |
来源读取禁用原因;与 CDC 原因分开。 |
错误响应¶
按错误与环境区分参数、能力、授权和运行状态;不要只凭 HTTP 200 判定业务成功。