GetTask - 擷取任務流節點配置

更新時間:
Copy as MD

調用GetTask介面,按照任務流節點ID擷取指定節點的配置,包括任務的時間變數。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetTask

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Tid

integer

租戶 ID。

說明

取自系統右上方頭像處懸停展示的租戶 ID 資訊,詳情請參見查看租戶資訊

3***

NodeId

integer

任務節點 ID。可調用 GetTaskInstanceRelation 介面擷取此參數的值。

51***

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求的 ID。用於定位日誌,排查問題。

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

ErrorCode

string

錯誤碼。

UnknownError

ErrorMessage

string

調用失敗時,返回的錯誤資訊。

UnknownError

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功

  • false:請求失敗

true

Task

object

任務流任務。

DagId

integer

節點所在的任務流 ID。

7321

NodeName

string

任務節點名稱。

跨庫Spark SQL-1

NodeType

string

任務節點類型,傳回值請參見 NodeType 參數說明

SPARK_SQL

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 字串格式,樣本及說明如下:

{
    "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***}"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情