調用CreateTask接口，創建任務流任務。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（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"
}
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "CFD8FE00-36D9-4C1B-940D-65A7B73D9066",
"ErrorCode": "InvalidParameterValid",
"ErrorMessage": "InvalidParameterValid",
"Success": true,
"NodeId": 0
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史