更新任务信息

最近更新时间:2025-06-26 01:50:47

我的收藏

1. 接口描述

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

更新任务Ds

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyTaskInfoDs。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目Id
示例值:1461767738399854597
TaskId String 任务ID
示例值:20250317220349191
DelayTime Integer 执行时间,单位分钟,天/周/月/年调度才有。比如天调度,每天的02:00点执行一次,delayTime就是120分钟
示例值:30
StartupTime Integer 启动时间:该字段已废弃,无需填写
SelfDepend Integer 自依赖类型 1:有序串行 一次一个 排队 2: 无序串行 一次一个 不排队 3:并行 一次多个;暂不支持其他值
示例值:1
StartTime String 生效开始时间,格式 yyyy-MM-dd HH:mm:ss
示例值:2025-05-21 00:00:00
EndTime String 生效结束时间,格式 yyyy-MM-dd HH:mm:ss
示例值:2099-12-31 23:59:59
TaskAction String 调度配置-弹性周期配置,小时/周/月/年调度才有,小时任务指定每天的0点3点4点跑,则为 0,3,4。设置该值时,请把CycleStep字段设置为1(如果原始值不为1)。
示例值:1,2
CycleType Integer 周期类型 0:crontab类型, 1:分钟,2:小时,3:天,4:周,5:月,6:一次性,7:用户驱动,10:弹性周期 周,11:弹性周期 月,12:年,13:即时触发Instant类型,与正常周期调度任务逻辑隔离
示例值:2
CycleStep Integer 小时和分钟任务才有;分钟任务:5、10、15、20、30,表示每隔5【或其他值】分钟执行一次;小时任务:1、2、3、4、5、6、7、8、9、10、11、12,表示每隔1【或其他值】小时执行一次。该值大于1时,请把TaskAction字段设置为空字符串。
示例值:5
CrontabExpression String cron表达式 周期类型为crontab调度才需要
示例值:0 0 0-23/1 * * ?
ExecutionStartTime String 执行时间左闭区间,格式:HH:mm 小时调度才有,例如小时任务, 每日固定区间生效
示例值:00:00
ExecutionEndTime String 执行时间右闭区间,格式:HH:mm 小时调度才有,例如小时任务, 每日固定区间生效
示例值:23:59
TaskName String 任务名,该字段废弃,请勿使用该字段重命名任务
示例值:taskName
RetryWait Integer 失败重试间隔,单位分钟,创建任务的时候已经给了默认值
示例值:1
TryLimit Integer 失败重试次数,创建任务的时候已经给了默认值
示例值:5
Retriable Integer 是否可重试,0代码不可重试,1代表可以重试;暂不支持其他值
示例值:0
RunPriority Integer 运行优先级,4高 5中 6低;暂不支持其他值
示例值:4
TaskExt.N Array of TaskExtInfo 任务的扩展配置
示例值:TaskExt
ResourceGroup String 执行资源组Id,需要去资源管理服务上创建调度资源组,并且绑定cvm机器
示例值:20252344239772390
YarnQueue String 资源池队列名称
示例值:default
BrokerIp String 资源组下具体执行机,any 表示可以跑在任意一台。
示例值:127.0.0.1
InCharge String 责任人,多个责任人请用分号隔开
示例值:user1;user2
Notes String 任务备注
示例值:note
TaskParamInfos.N Array of ParamInfo 任务参数
示例值:ParamInfo数组
SourceServer String 源数据源Id
示例值:9076
TargetServer String 目标数据源Id
示例值:9075
DependencyWorkflow String 是否支持工作流依赖 yes / no 默认 no
示例值:no
DependencyConfigDTOs.N Array of DependencyConfig 依赖配置,仅可修改上游任务实例配置方法
示例值:DependencyConfig
ExecutionTTL Integer 运行耗时超时时间分钟数
示例值:5
ScriptChange Boolean 脚本是否改变
示例值:true
ScheduleTimeZone String 任务时区,仅支持整数时区配置
示例值:UTC+8
ScheduleRunType Integer 0 正常调度 1 空跑调度;暂不支持其他值
示例值:0
ConcurrentStrategy Integer 0 并发度达到上限时,本次排队等待 1 并发度达到上限时,本次不执行,直接kill;暂不支持其他值
示例值:0
RegisterDsEventPublisherRequest RegisterDsEventPublisherReq shell任务发布事件
Content String base64编码后脚本内容
示例值:c2VsZWN0IDE7

3. 输出参数

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

4. 示例

示例1 成功示例

成功示例

输入示例

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

{
    "ProjectId": "1464962169590902784",
    "TaskId": "20241230120158580",
    "DelayTime": 240,
    "StartupTime": 0,
    "StartTime": "2025-02-13 00:00:00",
    "EndTime": "2100-01-01 23:59:59",
    "TaskAction": "",
    "CycleType": 2,
    "CycleStep": 1,
    "ExecutionStartTime": "04:00",
    "ExecutionEndTime": "03:59",
    "TaskName": "1230_test",
    "RetryWait": 5,
    "TryLimit": 5,
    "Retriable": 1,
    "RunPriority": 6,
    "TaskExt": [
        {
            "Key": "bucket",
            "Value": "wedata-fusion-dev-1257305158"
        },
        {
            "Key": "calendar_id",
            "Value": ""
        },
        {
            "Key": "ftp.file.name",
            "Value": "https://wedata-fusion-dev-1257305158.cos.ap-nanjing.myqcloud.com/datastudio/project/1464962169590902784/默认文件夹/peanut/test_delete_3/1230_test.sh"
        },
        {
            "Key": "tenantId",
            "Value": "1257305158"
        },
        {
            "Key": "calendar_open",
            "Value": "0"
        },
        {
            "Key": "calendar_name",
            "Value": ""
        },
        {
            "Key": "region",
            "Value": "ap-nanjing"
        },
        {
            "Key": "extraInfo",
            "Value": "&&&\"fromMapping\":false}"
        },
        {
            "Key": "data_cluster",
            "Value": ""
        },
        {
            "Key": "enableKerberosLogin",
            "Value": "false"
        },
        {
            "Key": "waitExecutionTotalTTL",
            "Value": "-1"
        },
        {
            "Key": "python_type",
            "Value": "python3"
        },
        {
            "Key": "python_sub_version",
            "Value": "python3"
        }
    ],
    "ResourceGroup": "20240703113703331017",
    "BrokerIp": "any",
    "InCharge": "peanutzhu",
    "Notes": "",
    "TaskParamInfos": [
        {
            "ParamKey": "value1",
            "ParamValue": "test"
        }
    ],
    "ExecutionTTL": -1,
    "ScriptChange": false,
    "ScheduleTimeZone": "UTC+8",
    "ScheduleRunType": 0,
    "RegisterDsEventPublisherRequest": {
        "ProjectId": "1464962169590902784",
        "Key": "20241230120158580",
        "Type": "REST_API",
        "Properties": [
            {
                "ParamKey": "eventVariable",
                "ParamValue": "events"
            }
        ],
        "Description": ""
    },
    "DependencyConfigDTOs": [
        {
            "ParentTask": {
                "TaskId": "20250606112604725"
            },
            "DependConfType": "MONTH",
            "SubordinateCyclicType": "CURRENT_MONTH",
            "DependencyStrategy": "EXECUTING"
        }
    ]
}

输出示例

{
    "Response": {
        "Data": true,
        "RequestId": "b41c3c3b-f7a8-4789-89f2-6b90711a6e5c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。