执行 SQL¶

执行一条 SQL，并返回查询 ID。使用该 ID 查看执行状态。

POST https://api.moi.matrixorigin.cn/v5/query/execute

调用前准备¶

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

调用身份需要具有目标数据库及 SQL 所引用对象的相应权限。不要将未经处理的用户输入直接拼接到 SQL 中。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和示例中的数据库名称、SQL 替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/query/execute" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "db_name": "sales",
    "query": "SELECT 1 AS n",
    "offset": 0,
    "limit": 20
  }'

参数说明

参数	类型	是否必填	说明
`db_name`	string	否	执行 SQL 时使用的数据库。
`query`	string	是	要执行的 SQL。
`sql_type`	string	否	调用方定义的 SQL 类型标识。
`offset`	integer	否	首个结果窗口的起始位置。
`limit`	integer	否	结果窗口的行数；未提供或小于等于 0 时，服务端使用 1000。

成功响应¶

响应仅返回查询 ID。记录该 ID 后，可继续查看执行状态。

响应示例

{
  "code": 200,
  "data": {
    "id": "query_01",
    "query_id": "query_01"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	integer	成功时为 `200`。
`data`	object	查询标识。

查询标识

下面表格展开响应示例中的 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`id`	string	查询 ID，与 `query_id` 相同。
`query_id`	string	查询 ID；用于查看状态或取消执行。

错误响应¶

响应示例

{
  "code": 400,
  "message": "请求参数无效"
}

字段说明

字段	类型	说明
`code`	integer	错误状态码。
`message`	string	错误信息。

后续操作¶

先查看执行状态。查询成功后，可查看执行结果或下载执行结果；仍在运行且需要停止时，可取消执行。

最后更新于 2026 年 9 月 28 日