调用CreateTask创建任务流任务_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

调用CreateTask接口，创建任务流任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
Tid	long	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	3***
DagId	long	是	任务流 ID，可通过调用接口 ListTaskFlow 或 ListLhTaskFlowAndScenario 获取该参数的值。	7***
NodeName	string	是	任务节点名称。	zhttest
NodeType	string	是	任务节点类型，取值请参见 NodeType 参数说明。	NORMAL_SQL
NodeContent	string	否	节点配置内容。	test
TimeVariables	string	否	节点变量（时间变量配置）。	test
NodeOutput	string	否	任务输出变量。	test
GraphParam	string	否	节点在图上的显示位置。	test

节点配置相关参数说明

根据节点类型的不同，节点的配置有所区别。此文档为任务流任务相关接口，如 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"
}

返回参数

名称	类型	描述	示例值
	object	返回参数值如下。
RequestId	string	请求 ID，用于定位日志，排查问题。	CFD8FE00-36D9-4C1B-940D-65A7B73D9066
ErrorCode	string	错误码。	InvalidParameterValid
ErrorMessage	string	调用失败时，返回的错误信息。	InvalidParameterValid
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
NodeId	long	创建成功时，返回的任务节点 ID。	3***

示例

正常返回示例

JSON格式

{
  "RequestId": "CFD8FE00-36D9-4C1B-940D-65A7B73D9066",
  "ErrorCode": "InvalidParameterValid",
  "ErrorMessage": "InvalidParameterValid",
  "Success": true,
  "NodeId": 0
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史