調用CreateTask介面,建立任務流任務。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:CreateTask |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Tid |
integer |
否 |
租戶 ID。 說明
取自系統右上方頭像處懸停展示的租戶 ID 資訊,詳情請參見查看租戶資訊。 |
3*** |
| DagId |
integer |
是 |
任務流 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 |
| NodeId |
integer |
建立成功時,返回的任務節點 ID。 |
3*** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "CFD8FE00-36D9-4C1B-940D-65A7B73D9066",
"ErrorCode": "InvalidParameterValid",
"ErrorMessage": "InvalidParameterValid",
"Success": true,
"NodeId": 0
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。