1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
创建离线任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateOfflineTask。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目ID 示例值:1486446569620893696 |
CycleStep | 是 | Integer | 间隔,可选,默认1。非空。默认 1 示例值:1 |
DelayTime | 是 | Integer | 延时执行时间,单位分钟 示例值:0 |
EndTime | 是 | String | 任务结束数据时间。非空。默认当前时间 示例值:2099-12-31 00:00:00 |
Notes | 是 | String | 备注 示例值:"备注信息“ |
StartTime | 是 | String | 当前日期 示例值:2022-04-21 00:00:00 |
TaskName | 是 | String | 任务名称 示例值:task test name |
TypeId | 是 | Integer | 跟之前调用调度接口保持一致27 示例值:27 |
TaskAction | 是 | String | 时间指定,如月任务指定1,3号,则填入 1,3。非空。默认 "" 月任务:如具体1,3号则写 "1,3",指定月末不可和具体号数一起输入,仅能为 "L" 示例值:1 |
TaskMode | 是 | String | 区分画布和表单 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20220411181355382 |
Data | String | 结果 示例值:”true" |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建离线任务
创建离线任务
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOfflineTask
<公共请求参数>
{
"ProjectId": "1486446569620893696",
"CycleStep": 1,
"DelayTime": 0,
"EndTime": "2099-12-31 00:00:00",
"Notes": "",
"StartTime": "2022-04-11 00:00:00",
"TaskName": "task test name",
"TypeId": 27,
"TaskAction": "",
"TaskMode": "1"
}
输出示例
{
"Response": {
"TaskId": "20220411181355382",
"Data": "true",
"RequestId": "7508483f-5202-44b3-a846-8c6efb42acb0"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |