1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
运行SQL脚本
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RunSQLScript。 |
| Version | 是 | String | 公共参数，本接口取值：2025-08-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProjectId | 是 | String | 项目ID 示例值：2924443218685956096 |
| ScriptId | 否 | String | 脚本id。如果不填则需要传入 ScriptConfig、ScriptContent，此时为免脚本临时运行模式，服务端不保存脚本 示例值：d61a6a13-630a-42ed-813c-326ebef4a35e |
| ScriptConfig | 否 | SQLScriptConfig | 脚本配置。免脚本临时运行模式（未传 ScriptId）下必填，其中 DatasourceId 必填、ExecutorGroupId 选填（缺省时使用项目管理-数据分析配置中的执行资源组）；传入 ScriptId 时本字段被忽略，配置取自已保存的脚本 |
| ScriptContent | 否 | String | 脚本内容，支持传递代码原文或者 Base64 编码，服务端自动识别。传 ScriptId 时不传则执行已保存的全量脚本内容；免脚本临时运行模式下必填。注意：若原文恰好由 Base64 字符集组成且长度为 4 的倍数（如 descTBLS），会被识别为已编码，此类内容请显式 Base64 编码后传入 示例值：c2VsZWN0IDE7 |
| Params | 否 | String | 高级运行参数，支持传递 JSON 格式原文或者 Base64 编码，服务端自动识别。示例：{"executorNum":1} 或 eyJleGVjdXRvck51bSI6MX0= 示例值：eyJleGVjdXRvck51bSI6MX0= |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | JobDto | 数据探索任务 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 运行已有脚本
传入 ScriptId 运行已保存的 SQL 脚本，运行配置（数据源、执行资源组等）取自该脚本。ScriptContent 不传则执行脚本已保存的全量内容；传入则覆盖本次运行的内容，支持原文或 Base64。本接口为异步提交，返回时任务通常仍在排队，需用 JobId 轮询 GetSQLRunResult 获取数据结果。注：本示例响应中 JobExecutionList 为 null 属历史数据，当前版本无论使用共享还是调度资源组，均会返回子查询列表（参见「免脚本临时运行」示例）。
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunSQLScript
<公共请求参数>
{
"ScriptId": "971c1520-836f-41be-b13f-7a6c637317c8",
"ProjectId": "1460947878944567296"
}输出示例
{
"Response": {
"Data": {
"CreateTime": "2025-09-18 15:28:32",
"EndTime": "2025-09-18 15:28:42",
"JobExecutionList": null,
"JobId": "6820250918152834057",
"JobName": "SQL脚本执行任务",
"JobType": "EXECUTOR",
"OwnerUin": "100043952936",
"ScriptContent": "--******************************************************************--\n--author: gordonzzhu\n--create time: 2025-01-14 21:05:48\n--可在左侧【库表】中查看数据库表信息\n--可在右上角修改数据探索的执行数据源等信息。\n--******************************************************************--\nSELECT 1;",
"ScriptContentTruncate": false,
"ScriptId": "0f2777fa-46d7-42cd-8b59-74ce47a375c0",
"Status": "S",
"TimeCost": 10000,
"UpdateTime": "2025-09-18 15:28:42",
"UserUin": "100028448903"
},
"RequestId": "08955a5f-497f-4bac-bac6-99c75191ffa7"
}
}示例2 免脚本临时运行
免脚本临时运行：不传 ScriptId，改传 ScriptConfig（DatasourceId 必填）与 ScriptContent 直接运行 SQL 片段，服务端不保存脚本。出参 ScriptId 为服务端生成的 adhoc- 前缀临时ID，可用于 ListSQLScriptRuns 反查。ScriptContent 支持原文或 Base64，本例传原文。ScriptConfig.ExecutorGroupId 未传时使用「项目管理-数据分析配置」中的执行资源组。注意：出参 JobId 为执行平台分配的任务ID，与 JobExecutionList[].JobExecutionId 配合使用；本接口为异步提交，返回时任务通常仍在排队（Status=QUEUED），需用 JobId 轮询 GetSQLRunResult 直至任务进入终态后获取数据结果。
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunSQLScript
<公共请求参数>
{
"ProjectId": "3327414454951170048",
"ScriptConfig": {
"DatasourceId": "65619",
"ComputeResource": "studio_2",
"ExecutorGroupId": "20260107105230846836"
},
"ScriptContent": "show databases;"
}输出示例
{
"Response": {
"Data": {
"JobId": "6820260903180522033",
"JobName": "20260903-1805",
"JobType": "EXECUTOR",
"ScriptId": "adhoc-f085e4ba-33ef-45ec-aba2-7e6def785510",
"ScriptContent": "show databases;",
"Status": "QUEUED",
"CreateTime": "2026-09-03 18:05:19",
"UpdateTime": "2026-09-03 18:05:19",
"EndTime": null,
"OwnerUin": "700001893691",
"UserUin": "700001893691",
"TimeCost": null,
"ScriptContentTruncate": false,
"JobExecutionList": [
{
"JobId": "6820260903180522033",
"JobExecutionId": "6820260903180522033_0",
"JobExecutionName": "Result1",
"ScriptContent": "show databases",
"Status": "QUEUED",
"CreateTime": "2026-09-03 18:05:19",
"UpdateTime": "2026-09-03 18:05:19",
"EndTime": null,
"TimeCost": null,
"ExecuteStageInfo": null,
"LogFilePath": null,
"ResultFilePath": null,
"ResultPreviewFilePath": null,
"SchemaInfoFilePath": null,
"ResultTotalCount": 0,
"ResultEffectCount": 0,
"ResultPreviewCount": 0,
"ContextScriptContent": null,
"CollectingTotalResult": false,
"CollectedPreviewResult": false,
"ScriptContentTruncate": false
}
]
},
"RequestId": "08232e9f-cc1c-431b-b43a-d6796eba87c2"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.InvalidJobState | 任务状态不允许该操作。任务仍处于排队或运行中等非终态时无法获取查询结果。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.ResultExpired | 任务结果已过期。查询结果与日志默认保留7天，超期后由后台任务清理。 |
