调用GetTask接口,按照任务流节点ID获取指定节点的配置,包括任务的时间变量。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetTask

系统规定参数。取值:GetTask

Tid Long 3***

租户ID。

说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息
NodeId Long 51***

任务节点ID。可调用GetTaskInstanceRelation接口获取此参数的值。

返回数据

名称 类型 示例值 描述
RequestId String 7838266C-E17B-58F4-B072-4DC356B58258

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

ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

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

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
Task Object

任务流任务。

DagId Long 7321

节点所在的任务流ID。

NodeName String 跨库Spark SQL-1

任务节点名称。

NodeType String SPARK_SQL

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

NodeContent String {\"dbList\":[{\"instanceId\":177****}" }

节点配置内容。

TimeVariables String {\"variables\":[{\"name\":\"Today\",\"pattern\":\"yyyy-MM-dd|+1d\"}]}

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

NodeConfig String {\"dbId\":39****,\"dbType\":\"mysql\",\"locale\":\"zh\",\"sql\":\"/* 请确认以下SQL符合您的变更需求,务必确认无误后再提交执行 */\\n\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\n\\t`id` bigint AUTO_INCREMENT DEFAULT '0',\\n\\t`age` bit NULL,\\n\\t`action` varchar(150) NULL,\\n\\t`elapse_time` datetime NULL,\\n\\tPRIMARY KEY (`id`)\\n) ENGINE=InnoDB\\nDEFAULT CHARACTER SET=utf8;\"}

节点高级配置。

NodeOutput String { "outputs":[ "extractMethod":"json" , "variableName":"var", "description":"demo desc" } ] }

节点输出变量,仅部分类型节点存在此参数。

GraphParam String {"{\"x\":0,\"y\":0,\"layoutType\":\"Horizontal\"}", "id": 51***}

节点在图上的显示位置。

TimeVariables为JSON字符串格式,示例及说明如下:

JSON
{
    "variables":[
        {
            "name":"var",// 变量命名
            /*
            变量格式
            语法示例如示例值所示——在运行时日期的基础上,偏移“分”、“时”、“日”、“周”、“月”、“年”(可缺省,可不按照此顺序)。
            */
            "pattern":"yyyy-MM-dd|+0d" 
        },
        {
            "name":"test",
            "pattern":"yyyy-MM-dd|+0d"
        }
    ]
}

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetTask
&NodeId=51***
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTaskResponse>
    <Task>
        <NodeName>跨库Spark SQL-1</NodeName>
        <NodeType>SPARK_SQL</NodeType>
        <DagId>73***</DagId>
        <NodeContent>{"dbId":39****,"dbType":"mysql","locale":"zh","sql":"\n\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\n\t`id` bigint AUTO_INCREMENT DEFAULT '0',\n\t`age` bit NULL,\n\t`action` varchar(150) NULL,\n\t`elapse_time` datetime NULL,\n\tPRIMARY KEY (`id`)\n) ENGINE=InnoDB\nDEFAULT CHARACTER SET=utf8;"}</NodeContent>
        <NodeConfig>{"rerun":{"rerunEnable":false}}</NodeConfig>
        <GraphParam>{"x":0,"y":0,"layoutType":"Horizontal"}</GraphParam>
    </Task>
    <RequestId>7838266C-E17B-58F4-B072-4DC356B58258</RequestId>
    <Success>true</Success>
</GetTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Task" : {
    "NodeName" : "跨库Spark SQL-1",
    "NodeType" : "SPARK_SQL",
    "DagId" : "73***",
    "NodeContent" : "{\"dbId\":39****,\"dbType\":\"mysql\",\"locale\":\"zh\",\"sql\":\"\\n\\nCREATE TABLE IF NOT EXISTS `momo_weekGather` (\\n\\t`id` bigint AUTO_INCREMENT DEFAULT '0',\\n\\t`age` bit NULL,\\n\\t`action` varchar(150) NULL,\\n\\t`elapse_time` datetime NULL,\\n\\tPRIMARY KEY (`id`)\\n) ENGINE=InnoDB\\nDEFAULT CHARACTER SET=utf8;\"}",
    "NodeConfig" : "{\"rerun\":{\"rerunEnable\":false}}",
    "GraphParam" : "{\"x\":0,\"y\":0,\"layoutType\":\"Horizontal\"}"
  },
  "RequestId" : "7838266C-E17B-58F4-B072-4DC356B58258",
  "Success" : true
}

错误码

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