更新任务

最近更新时间：2024-04-16 17:51:09

我的收藏

本页目录：

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

[注意：该版本只满足广州区部分白名单客户使用]

更新任务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyTaskInfo。
Version	是	String	公共参数，本接口取值：2021-08-20。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目Id 示例值："1995274688285233152"
TaskId	是	String	任务ID 示例值："20240328231651087"
DelayTime	否	Integer	执行时间，单位分钟，天/周/月/年调度才有。比如天调度，每天的02:00点执行一次，delayTime就是120分钟示例值：10
StartupTime	否	Integer	启动时间示例值：0
SelfDepend	否	Integer	自依赖类型 1:有序串行一次一个排队, 2: 无序串行一次一个不排队， 3:并行一次多个示例值：1
StartTime	否	String	生效开始时间，格式 yyyy-MM-dd HH:mm:ss 示例值："2023-03-18 11:51:00"
EndTime	否	String	生效结束时间，格式 yyyy-MM-dd HH:mm:ss 示例值："2099-03-18 23:59:59"
TaskAction	否	String	调度配置-弹性周期配置，小时/周/月/年调度才有，小时任务指定每天的0点3点4点跑，则为'0,3,4'。示例值："0,3,4"
CycleType	否	Integer	"周期类型 0:crontab类型, 1:分钟，2:小时，3:天，4:周，5:月，6:一次性，7:用户驱动，10:弹性周期周,11:弹性周期月,12:年,13:即时触发Instant类型，与正常周期调度任务逻辑隔离示例值：1
CycleStep	否	Integer	步长，间隔时间，最小1 示例值：1
CrontabExpression	否	String	cron表达式周期类型为crontab调度才需要示例值："0 0 0 * * ?"
ExecutionStartTime	否	String	执行时间左闭区间，格式：HH:mm 小时调度才有，例如小时任务, 每日固定区间生效示例值："00:00"
ExecutionEndTime	否	String	执行时间右闭区间，格式：HH:mm 小时调度才有，例如小时任务, 每日固定区间生效示例值："06:00"
TaskName	否	String	新的任务名示例值："new_name"
RetryWait	否	Integer	失败重试间隔,单位分钟，创建任务的时候已经给了默认值示例值：1
TryLimit	否	Integer	失败重试次数，创建任务的时候已经给了默认值示例值：5
Retriable	否	Integer	是否可重试，1代表可以重试示例值：1
RunPriority	否	Integer	运行优先级，4高 5中 6低示例值：5
TaskExt.N	否	Array of TaskExtInfo	任务的扩展配置示例值：TaskExtInfo数组
ResourceGroup	否	String	执行资源组id，需要去资源管理服务上创建调度资源组，并且绑定cvm机器示例值："202401040908070"
YarnQueue	否	String	资源池队列名称示例值："default"
BrokerIp	否	String	资源组下具体执行机，any 表示可以跑在任意一台。示例值："any"
Notes	否	String	任务备注示例值："test"
TaskParamInfos.N	否	Array of ParamInfo	任务参数示例值：ParamInfo数组
SourceServer	否	String	源数据源示例值："default"
TargetServer	否	String	目标数据源示例值："default"
DependencyWorkflow	否	String	是否支持工作流依赖 yes / no 默认 no 示例值："no"
DependencyConfigDTOs.N	否	Array of DependencyConfig	依赖配置示例值：DependencyConfig数组
ExecutionTTL	否	Integer	执行耗时示例值：-1
ScriptChange	否	Boolean	脚本是否改变示例值：false
InChargeIds.N	否	Array of String	责任人id 示例值：["102341324"]

3. 输出参数

参数名称	类型	描述
Data	Boolean	执行结果示例值：true
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 范例

修改任务信息

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTaskInfo
<公共请求参数>

{
    "ProjectId": "1492511691706699776",
    "TaskId": "20240307211852581",
    "DelayTime": 600,
    "StartupTime": 0,
    "SelfDepend": 0,
    "StartTime": "2024-03-28 00:00:00",
    "EndTime": "2024-03-29 00:00:00",
    "TaskAction": "",
    "CycleType": 3,
    "CycleStep": 1,
    "ExecutionStartTime": "00:00",
    "ExecutionEndTime": "23:59",
    "TaskName": "python_task_failed",
    "RetryWait": 5,
    "TryLimit": 5,
    "Retriable": 1,
    "RunPriority": 6,
    "TaskExt": [
        {
            "Key": "python_type",
            "Value": "python3"
        }
    ],
    "ResourceGroup": "20221229172428663695",
    "BrokerIp": "ins-g8j6pv4f",
    "InCharge": "micofywang",
    "Notes": "test",
    "TaskParamInfos": [
        {
            "ParamKey": "a",
            "ParamValue": "3"
        }
    ],
    "DependencyWorkflow": "no",
    "InChargeIds": [
        "100033435965"
    ]
}

输出示例

{
    "Response": {
        "Data": true,
        "RequestId": "d7f6c6d3-d483-4485-b600-c665c9aea28b"
    }
}

示例2 错误示例

错误示例

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTaskInfo
<公共请求参数>

{
    "ProjectId": "1",
    "TaskId": "1"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "请求签名验证失败，请检查您的签名计算是否正确。"
        },
        "RequestId": "11d5af39-eac3-4960-b0d5-5cced5cdc49f"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。

上一篇: 查询任务脚本下一篇: 添加父任务依赖