1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
创建任务
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateTask。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskName | 是 | String | 任务名称，任务长度64字符 示例值：test |
| TaskContent | 是 | String | 任务内容，长度限制65536个字节 示例值：com.example.task.simpleTask |
| ExecuteType | 是 | String | 执行类型，unicast/broadcast 示例值：unicast |
| TaskType | 是 | String | 任务类型,java 示例值：java |
| TimeOut | 是 | Integer | 任务超时时间， 时间单位 ms 示例值：30000 |
| GroupId | 是 | String | 部署组ID 示例值：group-12345678 |
| TaskRule | 否 | TaskRule | 触发规则 |
| RetryCount | 否 | Integer | 重试次数，0 <= RetryCount<= 10 示例值：0 |
| RetryInterval | 否 | Integer | 重试间隔， 0 <= RetryInterval <= 600000， 时间单位 ms 示例值：0 |
| ShardCount | 否 | Integer | 分片数量 示例值：0 |
| ShardArguments.N | 否 | Array of ShardArgument | 分片参数 |
| SuccessOperator | 否 | String | 判断任务成功的操作符 示例值：GTE |
| SuccessRatio | 否 | String | 判断任务成功率的阈值，如100 示例值：100 |
| AdvanceSettings | 否 | AdvanceSettings | 高级设置 |
| TaskArgument | 否 | String | 任务参数，长度限制10000个字符 示例值：taskArgumentTest |
| ProgramIdList.N | 否 | Array of String | 无 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 任务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：task-12345678 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建任务
创建任务
输入示例
https://tsf.tencentcloudapi.com/?Action=CreateTask
&TaskName=test
&TaskContent=com.example.task.simpleTask
&TaskArgument=taskArgumentTest
&ExecuteType=UNICAST
&TaskType=JAVA
&TaskRule.RuleType=Cron
&TaskRule.RepeatInterval=0
&TaskRule.Expression=00/1****?
&TimeOut=30000
&GroupId=group-12345678
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "6281ddf9-1914-420b-afb8-93735ac3270a",
"Result": "task-12345678"
}
}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.TaskCreateError | 任务创建异常。 |
| FailedOperation.TaskOperationForbidden | 禁止操作。 |
| InternalError.TaskInternalError | 任务内部异常。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| InvalidParameter.BadRequest | [%s]模块接口[%s]请求不正确（400 BAD REQUEST）。。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue.InvalidParameterFormat | 参数格式异常。 |
| InvalidParameterValue.TaskParameterInvalid | 无效请求参数。 |
| MissingParameter.TaskParameterMissed | 缺少必填参数。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.CamTsfRoleNoPermission | 协作者身份未授权，需要主账号授予协作者权限，参考 TSF 官网文档「快速入门/准备工作」。 |
| UnauthorizedOperation.CamTsfRoleNotExist | 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。 |
| UnauthorizedOperation.LicenseInactive | License未激活。。 |
| UnauthorizedOperation.LicenseUnauthorized | 您所购买的服务不支持该操作。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |