创建任务
最近更新时间: 2024-10-18 10:38:39
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.cn。
创建任务
默认接口请求频率限制：20次/秒。
接口更新时间：2021-03-01 15:05:46。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateTask |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| TaskName | 是 | 否 | String | 任务名称，任务长度64字符 |
| TaskContent | 是 | 否 | String | 任务内容，长度限制65536个字节 |
| ExecuteType | 是 | 否 | String | 执行类型，UNICAST/BROADCAST |
| TaskType | 是 | 否 | String | 任务类型 |
| 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个字符 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 此参数对外不可见。 任务ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | |
| UnauthorizedOperation.LicenseUnauthorized | |
| UnauthorizedOperation.LicenseInactive | |
| UnauthorizedOperation.CamTsfRoleNoPermission | |
| UnauthorizedOperation.CamTsfRoleNotExist | |
| InternalError.TaskInternalError | |
| FailedOperation.TaskCreateError | |
| FailedOperation.TaskOperationForbidden | |
| MissingParameter.TaskParameterMissed | |
| InvalidParameterValue.TaskParameterInvalid | |
| InvalidParameterValue.InvalidParameterFormat | |
| InvalidParameter.BadRequest | |
| UnauthorizedOperation.NoPrivilege | |
| InternalError.UnhandledException |