1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.com。
创建任务
默认接口请求频率限制：20次/秒。
接口更新时间：2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateTask |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| TaskName | 是 | 否 | String | 任务名称，任务长度64字符 示例值： |
| TaskContent | 是 | 否 | String | 任务内容，长度限制65536个字节 示例值： |
| ExecuteType | 是 | 否 | String | 执行类型，unicast/broadcast 示例值： |
| TaskType | 是 | 否 | String | 任务类型,java 示例值： |
| TimeOut | 是 | 否 | Uint64 | 任务超时时间， 时间单位 ms 示例值： |
| TaskRule | 否 | 否 | TaskRule | 触发规则 示例值：查看 |
| RetryCount | 否 | 否 | Uint64 | 重试次数，0 <= RetryCount<= 10 示例值： |
| RetryInterval | 否 | 否 | Uint64 | 重试间隔， 0 <= RetryInterval <= 600000， 时间单位 ms 示例值： |
| GroupId | 是 | 否 | String | 部署组ID 示例值： |
| ShardCount | 否 | 否 | Int64 | 分片数量 示例值： |
| ShardArguments | 否 | 否 | Array of ShardArgument | 分片参数 示例值：查看 |
| SuccessOperator | 否 | 否 | String | 判断任务成功的操作符 示例值： |
| SuccessRatio | 否 | 否 | String | 判断任务成功率的阈值，如100 示例值： |
| AdvanceSettings | 否 | 否 | AdvanceSettings | 高级设置 示例值：查看 |
| TaskArgument | 否 | 否 | String | 任务参数，长度限制10000个字符 示例值： |
| ProgramIdList | 否 | 否 | Array of String | 无 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 任务ID 示例值： |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| UnauthorizedOperation.LicenseUnauthorized | 您所购买的服务不支持该操作。 |
| UnauthorizedOperation.LicenseInactive | License未激活。。 |
| UnauthorizedOperation.CamTsfRoleNoPermission | 协作者身份未授权，需要主账号授予协作者权限，参考 TSF 官网文档「快速入门/准备工作」。 |
| UnauthorizedOperation.CamTsfRoleNotExist | 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。 |
| InternalError.TaskInternalError | 任务内部异常。 |
| FailedOperation.TaskCreateError | 任务创建异常。 |
| FailedOperation.TaskOperationForbidden | 禁止操作。 |
| MissingParameter.TaskParameterMissed | 缺少必填参数。 |
| InvalidParameterValue.TaskParameterInvalid | 无效请求参数。 |
| InvalidParameterValue.InvalidParameterFormat | 参数格式异常。 |
| InvalidParameter.BadRequest | [%s]模块接口[%s]请求不正确（400 BAD REQUEST）。。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |