运行SQL脚本

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

运行SQL脚本

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。