文档

GetTask - 获取任务流节点配置

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Tidlong

租户 ID。

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

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

51***

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

7838266C-E17B-58F4-B072-4DC356B58258
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

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

UnknownError
Successboolean

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

  • true:请求成功
  • false:请求失败
true
Taskobject

任务流任务。

DagIdlong

节点所在的任务流 ID。

7321
NodeNamestring

任务节点名称。

跨库Spark SQL-1
NodeTypestring

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

SPARK_SQL
NodeContentstring

节点配置内容。

{\"dbList\":[{\"instanceId\":177****}" }
TimeVariablesstring

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

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

节点高级配置。

{\"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;\"}
NodeOutputstring

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

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

节点在图上的显示位置。

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

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

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

示例

正常返回示例

JSON格式

{
  "RequestId": "7838266C-E17B-58F4-B072-4DC356B58258",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Task": {
    "DagId": 7321,
    "NodeName": "跨库Spark SQL-1",
    "NodeType": "SPARK_SQL",
    "NodeContent": "{\\\"dbList\\\":[{\\\"instanceId\\\":177****}\"   }",
    "TimeVariables": "{\\\"variables\\\":[{\\\"name\\\":\\\"Today\\\",\\\"pattern\\\":\\\"yyyy-MM-dd|+1d\\\"}]}",
    "NodeConfig": "{\\\"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": "{ \"outputs\":[ \"extractMethod\":\"json\" , \"variableName\":\"var\",   \"description\":\"demo desc\" } ] }",
    "GraphParam": "{\"{\\\"x\\\":0,\\\"y\\\":0,\\\"layoutType\\\":\\\"Horizontal\\\"}\",  \"id\": 51***}"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈