1. 接口描述
接口请求域名： pts.tencentcloudapi.com 。
创建定时任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCronJob。 |
| Version | 是 | String | 公共参数，本接口取值：2021-07-28。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Name | 是 | String | 定时任务名字 示例值：cronjob |
| ProjectId | 是 | String | 项目ID 示例值：project-xx |
| ScenarioId | 是 | String | 场景ID 示例值：scenario-xx |
| ScenarioName | 是 | String | 场景名称 |
| FrequencyType | 是 | Integer | 执行频率类型，1:只执行一次; 2:日粒度; 3:周粒度; 4:高级 示例值：1 |
| CronExpression | 是 | String | cron表达式 示例值：*/1 * * * * |
| JobOwner | 是 | String | 任务发起人 示例值：tom |
| EndTime | 否 | Timestamp ISO8601 | 结束时间 示例值：2014-08-03T12:00:00+08:00 |
| NoticeId | 否 | String | Notice ID 示例值：notice-xx |
| Note | 否 | String | 备注 示例值：定时任务备注 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CronJobId | String | 定时任务ID 示例值：cron-xx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建定时任务
创建定时任务
输入示例
POST / HTTP/1.1
Host: pts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCronJob
<公共请求参数>
{
"ProjectId": "project-xx",
"ScenarioId": "scenario-xx",
"ScenarioName": "scenario name",
"Name": "cron name",
"CronExpression": "*/1 * * * *",
"FrequencyType": 1,
"EndTime": "2020-09-22T00:00:00+00:00",
"NoticeId": "notice-xx",
"JobOwner": "tom"
}输出示例
{
"Response": {
"RequestId": "req-xx",
"CronJobId": "cron-xx"
}
}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 | 操作失败。 |
| FailedOperation.DbRecordCreateFailed | 数据库创建记录失败。 |
