1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
即席分析提交SQL任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SubmitSqlTask。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DatabaseType | 是 | String | 数据库类型 示例值：HIVE |
| DatasourceId | 是 | Integer | 数据源Id 示例值：4321 |
| GroupId | 是 | String | 资源组Id 示例值：20240409152903400000 |
| ScriptId | 是 | String | 脚本文件id 示例值：c6bff4c1-3ff1-4765-82b6-000000000 |
| ProjectId | 是 | String | 项目id 示例值：1485413111111111111 |
| DatabaseName | 否 | String | 数据库名称 示例值：databaseDemo |
| EngineId | 否 | String | 执行引擎实例ID 示例值：emr-demo |
| ScriptContent | 否 | String | 脚本内容 示例值：LS1TUUwKLS0qKioqKio |
| ResourceQueue | 否 | String | 资源队列 示例值：default |
| DatasourceType | 否 | String | 数据库类型 示例值：HIVE |
| ComputeResource | 否 | String | 计算资源名称 示例值：default |
| RunParams | 否 | String | 高级运行参数 示例值：{"yyyy-MM-dd HH:mm:ss":"2024-04-15 15:36:30"} |
| ConfParams | 否 | String | 高级设置 示例值：{"RunConfParams":"","AdhocFileName":"sqldemo.sql","ResourceConfParams":{}} |
| ScriptEncryption | 否 | Boolean | 脚本内容是否base64加密 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Record | AdhocRecord | 任务提交记录 示例值：{"CreateTime":"2024-04-15T15:36:34+08:00","Id":11111,"InstanceId":"620240415151111111_2024-04-15T15:36:35+08:00","ScriptContent":"\n\n\n\n\nselect 1\n","Status":"WAITING"} |
| Details | Array of AdhocDetail | 子任务记录列表 示例值：{"EndTime":null,"Id":11111,"RecordId":11111,"ScriptContent":"select 1","StartTime":null,"Status":"WAITING"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求demo
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitSqlTask
<公共请求参数>
{
"ProjectId": "148541391437111111111",
"DatasourceType": "HIVE",
"DatasourceId": 1111,
"GroupId": "20240409111111111",
"ResourceQueue": "default",
"ComputeResource": "",
"DatabaseName": "",
"ConfParams": "{\"RunConfParams\":\"\",\"AdhocFileName\":\"sqldemo.sql\",\"ResourceConfParams\":{}}",
"DatabaseType": "HIVE",
"ScriptId": "c6bff4c1-3ff1-4765-82b6-1111111",
"ScriptContent": "LS1T",
"ScriptEncryption": true,
"RunParams": ""
}输出示例
{
"Response": {
"Details": [
{
"EndTime": null,
"Id": 43248,
"RecordId": 30388,
"ScriptContent": "select 1",
"StartTime": null,
"Status": "WAITING"
}
],
"Record": {
"CreateTime": "2024-04-15T15:36:34+08:00",
"Id": 30388,
"InstanceId": "6202404151536358025_2024-04-15T15:36:35+08:00",
"ScriptContent": "\n\n\n\n\nselect 1\n",
"Status": "WAITING"
},
"RequestId": "65e7142b-7d21-4df8-af43-b5705a6f8923"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.SignatureExpire | 未登录或登录已过期。 |
| AuthFailure.UnauthorizedOperation | CAM未授权，请联系主账号到CAM中授权QcloudWeDataFullAccess策略给该账户。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.InternalCallCloudApiError | 调用云API失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DataEngineInstanceNotExists | 数据引擎实例不存在。 |
| InvalidParameter.WeDataRoleNotExists | WeData_QCSRole不存在，请进行服务授权。 |
| InvalidParameter.WorkspaceNotExist | 工作空间不存在。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |