CreateTask_数据管理_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为100/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dms:CreateTask
Create
全部资源
*

请求参数

字段名称字段详情
Tidinteger<int64>

租户 ID。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:3***取值 <= 9223372036854775807
DagIdinteger<int64>

任务流 ID,可通过调用接口 ListTaskFlowListLhTaskFlowAndScenario 获取该参数的值。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:7***
NodeNamestring

任务节点名称。

示例值:zhttest
NodeTypestring

任务节点类型,取值请参见 NodeType 参数说明

示例值:NORMAL_SQL
NodeContentstring

节点配置内容。

示例值:test
TimeVariablesstring

节点变量(时间变量配置)。

示例值:test
NodeOutputstring

任务输出变量。

示例值:test
GraphParamstring

节点在图上的显示位置。

示例值:test参考取值来源:
    GetTaskFlowGraph

请求说明

节点配置相关参数说明

根据节点类型的不同,节点的配置有所区别。此文档为任务流任务相关接口,如 CreateTask、UpdateTaskOutput 等接口的补充说明,其中 NodeParam、NodeContent、GraphParam 的配置具有通用性。
当前仅“单实例 SQL 赋值”、“脚本代码”、“Ecs 远程命令”任务节点具有输出变量,配置方式有所区别,详情可参考 UpdateTaskOutput 接口文档说明。

单实例 SQL

  • DagId
  • NodeName
  • NodeType: NORMAL_SQL
  • NodeParam
  • GraphParam
  • NodeContent: 样例如下
{
    "dbId":123456, // 数据库 Id
    "sql":"/* 请使用当前节点所选择的数据库语法编写 SQL */", // sql 语句
    "dbType":"lindorm_sql" // 数据库类型
}

脚本代码

  • DagId
  • NodeName
  • NodeType: AZKABAN_COMMAND_REMOTE
  • NodeParam
  • GraphParam
  • NodeOutput
{
    "outputs":[
        {
            "extractMethod":"json", // 固定为 json
            "variableName":"var",  // 变量名
            "description":"demo desc" // 变量描述
        }
    ]
}
  • NodeContent:样例如下
{
    "regionId":"cn-hangzhou", // 地域
    "gatewayId":"dg-xxxxxxxxxxxxxx", // 网关 ID
    "gatewayInstanceId":"dg-node-xxxxxxxxxxxxxx", // 网关实例 ID
    "scriptFileName":"demo.sh", // 文件名
    "args":[ // 运行参数
        "-n value",
        "-n1 value1"
    ]
}

无锁数据变更

  • DagId
  • NodeName
  • NodeType: NLOCK_DATA_CORRECT
  • NodeParam
  • GraphParam
  • NodeContent: 样例如下
{
    "dbId":123456, // 数据库 Id
    "sql":"/* 请使用当前节点所选择的数据库语法编写 SQL */", // sql 语句
    "dbType":"polardb" // 数据库类型
}

单实例 SQL 赋值

  • DagId
  • NodeName
  • NodeType: SQL_ASSIGNMENT
  • NodeParam
  • GraphParam
  • NodeOutput: 样例如下
{
    "outputs":[
        {
            /*
            // 变量提取设置
            {
                "row":0, // 行,-1 为所有行
                "column":-1, // 列,-1 为所有列
                "combiner":"," // 分隔符,当选中所有行或所有列时,需要指定连接符。变量返回值为字符串
            }
            */
            "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", 
            "variableName":"var", // 变量名
            "description":"For demo" // 变量介绍
        }
    ]
}
  • NodeContent: 样例如下
{
    "dbId":123456, // 数据库 Id
    "sql":"/* 请使用当前节点所选择的数据库语法编写 SQL,仅支持 SELECT 语句,且默认返回最大行数为 30 *", // sql 语句
    "dbType":"lindorm_cql" // 数据库类型
}

依赖检查

  • DagId
  • NodeName
  • NodeType: DEPENDENCY_CHECK
  • NodeParam
  • GraphParam
  • NodeContent: 样例如下
{
    "dependentDAGId":132,  // 依赖项:任务流
    "dependentNodeId":"", // 依赖项:单个节点,缺省时依赖项为指定的任务流
    "dependentStartTimePattern":"yyyy-MM-dd HH:mm|-2d+0h+0m", // 开始时间偏移点
    "dependentEndTimePattern":"yyyy-MM-dd HH:mm|+1d+0h+0m", // 结束时间偏移点
    "multiSuccessStrategy":2, //  实例检查策略: 0.最后一次成功; 1.全部成功; 2.指定单次成功
    "multiSuccessStrategyIndex":1 // 实例检查策略: 第 x+1 次
}

表时间列状态检查

  • DagId
  • NodeName
  • NodeType: TABLE_TIME_CHECK
  • NodeParam
  • GraphParam
  • NodeContent: 样例如下
{
    "dependentDAGId":132,  // 依赖项:任务流
    "dependentNodeId":"", // 依赖项:单个节点,缺省时依赖项为指定的任务流
    "dependentStartTimePattern":"yyyy-MM-dd HH:mm|-2d+0h+0m", // 开始时间偏移点
    "dependentEndTimePattern":"yyyy-MM-dd HH:mm|+1d+0h+0m", // 结束时间偏移点
    "multiSuccessStrategy":2, //  实例检查策略: 0.最后一次成功; 1.全部成功; 2.指定单次成功
    "multiSuccessStrategyIndex":1 // 实例检查策略: 第 x+1 次
}

SQL 状态检查

  • DagId
  • NodeName
  • NodeType: SQL_STATUS_CHECK
  • NodeParam
  • GraphParam
  • NodeContent: 样例如下
{
    "dbId":123456,
    "sql":"/* 请使用当前节点所选择的数据库语法编写 SQL */ \n\n select 1 from abc",
    "dbType":"lindorm_cql"
}

返回参数

字段名称字段详情
RequestIdstring

请求 ID,用于定位日志,排查问题。

示例值:CFD8FE00-36D9-4C1B-940D-65A7B73D9066
ErrorCodestring

错误码。

示例值:InvalidParameterValid
ErrorMessagestring

调用失败时,返回的错误信息。

示例值:InvalidParameterValid
Successboolean

请求是否成功,返回值如下:展开详情

示例值:true
NodeIdinteger<int64>

创建成功时,返回的任务节点 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:3***

返回示例

变更历史

暂无变更历史

相关示例