1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
新增SQL脚本
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateSQLScript。 |
Version | 是 | String | 公共参数,本接口取值:2025-08-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ScriptName | 是 | String | 脚本名称 示例值:test_sql2 |
ProjectId | 是 | String | 项目Id 示例值:2912854921119117312 |
ParentFolderPath | 否 | String | 父文件夹path,/aaa/bbb/ccc,根目录为空字符串或/ 示例值:/data |
ScriptConfig | 否 | SQLScriptConfig | 数据探索脚本配置 |
ScriptContent | 否 | String | 脚本内容,如有值,则要将内容进行base64编码 示例值:c2VsZWN0IDE7 |
AccessScope | 否 | String | 权限范围:SHARED, PRIVATE 示例值:SHARED |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | SQLScript | 结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSQLScript
<公共请求参数>
{
"ScriptName": "test_sql2",
"ProjectId": "2912854921119117312",
"ParentFolderPath": "",
"ScriptContent": "c2VsZWN0IDE7",
"AccessScope": "SHARED"
}
输出示例
{
"Response": {
"Data": {
"AccessScope": "SHARED",
"CreateTime": "2025-08-28 17:20:31",
"OwnerUin": "100032159948",
"ParentFolderPath": "",
"Path": "/test_sql2",
"ProjectId": "2912854921119117312",
"ScriptConfig": {
"AdvanceConfig": null,
"ComputeResource": null,
"DatasourceEnv": null,
"DatasourceId": null,
"ExecutorGroupId": null,
"Params": null
},
"ScriptContent": "c2VsZWN0IDE7",
"ScriptId": "bf6a325f-ab82-4fba-9eac-1b6ae58f20f6",
"ScriptName": "test_sql2",
"UpdateTime": "2025-08-28 17:20:31",
"UpdateUserUin": "100032159948"
},
"RequestId": "619c3bba-7376-4af3-b7f6-511cf9ebf1bd"
}
}
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 | 操作失败。 |