修改任务

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.com。

修改任务

默认接口请求频率限制:10000次/秒。

接口更新时间:2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:ModifyTask
Version 是 否 String 公共参数,本接口取值:2018-03-26
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
TaskArgument 否 否 String 任务参数,长度限制10000个字符
示例值:
ProgramIdList 否 否 Array of String 无
示例值:
TaskContent 否 否 String 任务内容
示例值:
TimeOut 否 否 Uint64 超时时间,单位 ms
示例值:
SuccessRatio 否 否 Int64 判断任务成功率的阈值
示例值:
RetryCount 否 否 Uint64 重试次数
示例值:
TaskId 是 否 String 任务ID
示例值:
ShardCount 否 否 Int64 分片数量
示例值:
SuccessOperator 否 否 String 判断任务成功的操作符 GT/GTE
示例值:
ExecuteType 否 否 String 任务执行类型
示例值:
TaskRule 否 否 TaskRule 触发规则
示例值:查看
TaskName 否 否 String 任务名称
示例值:
TaskType 否 否 String 任务类型
示例值:
GroupId 否 否 String 分组ID
示例值:
ShardArguments 否 否 Array of ShardArgument 分片参数
示例值:查看
AdvanceSettings 否 否 AdvanceSettings 高级设置
示例值:查看
RetryInterval 否 否 Uint64 重试间隔
示例值:

3. 输出参数

参数名称 类型 描述
Result Bool 更新是否成功
示例值:
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。

错误码 描述
UnauthorizedOperation.LicenseUnauthorized 您所购买的服务不支持该操作。
UnauthorizedOperation.LicenseInactive License未激活。。
UnauthorizedOperation.CamTsfRoleNoPermission 协作者身份未授权,需要主账号授予协作者权限,参考 TSF 官网文档「快速入门/准备工作」。
UnauthorizedOperation.CamTsfRoleNotExist 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。
FailedOperation.TaskUpdateError 任务更新异常。
ResourceNotFound.TaskNotFound 任务不存在。
MissingParameter.TaskParameterMissed 缺少必填参数。
InvalidParameterValue.TaskParameterInvalid 无效请求参数。
InvalidParameterValue.InvalidParameterFormat 参数格式异常。
InvalidParameter.BadRequest [%s]模块接口[%s]请求不正确(400 BAD REQUEST)。。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。

5. 示例

示例1 修改任务

修改任务

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=ModifyTask
&TaskId=task-klwqrnlw
&TaskName=demohaha
&<Common Parameters>

输出示例

{
  "Response": {
    "Result": true,
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}