1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
获取SQL查询任务的数据结果。直接返回预览数据结果,而非预览结果文件路径。不传 JobExecutionId 时返回该任务下全部子查询的结果数组。返回数据总大小不超过 10MB。任务处于非终态(QUEUED/RUNNING)时不报错,返回当前 Status 与空的 Results 数组,并通过 StatusMessage 说明原因,调用方应采用指数退避策略轮询直至进入终态。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetSQLRunResult。 |
| Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值:2924443218685956096 |
| JobId | 是 | String | 查询任务ID,由 RunSQLScript 返回 示例值:17676143448574812 |
| JobExecutionId | 否 | String | 子查询任务运行ID。不传则返回该任务下全部子查询的结果 示例值:17676143448574813 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | SqlRunResult | SQL查询结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功响应
查询任务已执行成功,返回两个字段、两行数据。Rows 中每个元素为一行,其 Values 顺序与 Columns 一致;单元格均为字符串(底层预览结果为 CSV 格式,不携带类型信息),字段真实类型参见 Columns[].ColumnType。
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSQLRunResult
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"JobId": "6820250918152834057"
}
输出示例
{
"Response": {
"Data": {
"JobId": "6820250918152834057",
"Status": "SUCCESS",
"StatusMessage": "任务执行成功,已返回全部查询结果",
"CostMs": 10000,
"Truncated": false,
"Results": [
{
"JobExecutionId": "6820250918152834057-1",
"Status": "SUCCESS",
"Columns": [
{
"ColumnName": "id",
"ColumnType": "int"
},
{
"ColumnName": "name",
"ColumnType": "string"
}
],
"Rows": [
{
"Values": [
"1",
"Alice"
]
},
{
"Values": [
"2",
null
]
}
],
"Total": 2,
"CostMs": 12,
"Truncated": false
}
]
},
"RequestId": "08955a5f-497f-4bac-bac6-99c75191ffa7"
}
}
示例2 任务未执行完成(轮询中)
任务仍处于非终态(QUEUED/RUNNING)时本接口不报错,返回当前 Status 与空的 Results 数组,并通过 StatusMessage 说明原因与下一步动作。调用方应据此指数退避轮询,直至 Status 变为 SUCCESS/FAILED/TERMINATED/CANCELED 之一。注意 FAILED/TERMINATED/CANCELED 同为终态且同样没有结果数据,请以 StatusMessage 判断是继续等待还是终止轮询。
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetSQLRunResult
<公共请求参数>
{
"ProjectId": "1460947878944567296",
"JobId": "6820250918152834057"
}
输出示例
{
"Response": {
"Data": {
"JobId": "6820250918152834057",
"Status": "RUNNING",
"StatusMessage": "任务尚未执行完成,当前无结果数据,请使用相同的 JobId 稍后重试",
"CostMs": 3200,
"Truncated": false,
"Results": []
},
"RequestId": "1f0c2b7e-6d4a-4f31-9a55-3c1d8e02b4aa"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.ResultExpired | 任务结果已过期。查询结果与日志默认保留7天,超期后由后台任务清理。 |