Rest Client
更新時間 2023-08-17 17:07:16
最近更新時間: 2023-08-17 17:07:16
分享文章
本章節主要介紹節點參考的 Rest Client。
功能
通過Rest Client節點執行一個內的RESTful請求,目前只支持IAM Token認證鑒權方式的RESTful請求。
說明當由于網絡限制,Rest Client某些API無法調通時,可以嘗試使用Shell腳本進行API調用。您需要擁有ECS彈性云主機,并確保ECS主機和待調用的API之間網絡可通,然后在DataArts Studio創建主機連接,通過Shell腳本使用CURL命令進行API調用。
參數
用戶可參考下表中配置Rest Client節點的參數。
屬性參數
| 參數 | 是否必選 | 說明 |
|---|---|---|
| 節點名稱 | 是 | 節點名稱,可以包含中文、英文字母、數字、“_”、“-”、“/”、“<”、“>”等各類特殊字符,長度為1~128個字符。 |
| 代理集群名稱 | 是 | 選擇CDM集群名稱,CDM集群提供代理連接的功能。如果選擇選擇的CDM集群與第三方服務處于同一個VPC下,那么Rest Client可以調用租戶面的API。 |
| URL地址 | 是 | 填寫請求主機的IP或域名地址,以及端口號。例如://192.160.10.10:8080 |
| HTTP方法 | 是 | 選擇請求的類型: GET POST PUT DELETE |
| 請求頭 | 否 | 單擊![]() ,添加請求消息頭,參數說明如下:參數名稱 選擇參數的名稱,選項為“Content-Type”、“Accept-Language”。 參數值 填寫參數的值。 |
| URL參數 | 否 | 填寫URL參數,格式為“參數=值”形式的字符串,字符串間以換行符分隔。當“HTTP方法”為“GET”時,顯示該配置項。參數說明如下: 參數 只支持英文字母、數字、“-”、“*”,*最大長度為32字符。 值 只支持英文字母、數字、“-”、“”、“$”、“{”和“}”,最大長度為64字符。 |
| 請求消息體 | 是 | 填寫Json格式的請求消息體。當“HTTP方法”為“POST”、“PUT”時,顯示該配置項。 |
| 是否需要判斷返回值 | 否 | 設置是否判斷返回消息的值和預期的一致。當“HTTP方法”為“GET”時,顯示該配置項。 YES:檢查返回消息中的值是否和預期的一致。 NO:不檢查,請求返回200響應碼(表示節點執行成功)。 |
| 返回值字段路徑 | 是 | 填寫Json響應消息中某個屬性的路徑(下稱:Json屬性路徑),每個Rest Client節點都只能配置一個屬性的路徑。當“是否需要判斷返回值”為“YES”時,顯示該配置項。 例如,返回結果為: { "param1": "aaaa", "inner": { "inner": { "param4": 2014247437 }, "param3": "cccc" }, "status": 200, "param2": "bbbb" } 其中“param4”屬性的路徑為“inner.inner.param4”。 |
| 請求成功標志位 | 是 | 填寫請求成功標志位,如果響應消息的返回值與請求成功標志位中的某一個匹配,表示節點執行成功。當“是否需要判斷返回值”為“YES”時,顯示該配置項。請求成功標志位只支持英文字母、數字、“-”、“_”、“$”、“{”、“}”,多個值使用“;”分隔。 |
| 請求失敗標志位 | 否 | 填寫請求失敗標志位,如果響應消息的返回值與請求失敗標志位中的某一個匹配,表示節點執行失敗。當“是否需要判斷返回值”為“YES”時,顯示該配置項。請求失敗標志位只支持英文字母、數字、“-”、“_”、“$”、“{”、“}”,多個值使用“;”分隔。 |
| 請求間隔時間(秒) | 是 | 如果響應消息的返回值與請求成功標志位不匹配,將每隔一段時間查詢一次,直到響應消息的返回值與請求成功標志位一致。節點執行的超時時間默認為1小時,如果1小時內查詢的結果始終為不匹配,那么節點的狀態將置為失敗。當“是否需要判斷返回值”為“YES”時,顯示該配置項。 |
| 響應消息體解析為傳遞參數定義 | 否 | 設置作業變量與Json屬性路徑的對應關系,參數間以換行符分隔。例如:var4=inner.inner.param4其中,“var4”為作業變量,作業變量只支持英文字母、數字,最大長度為64字符;“inner.inner.param4”為Json屬性路徑。僅該節點的后續節點引用該參數才會生效,引用該參數時,格式為:${var4}。 |
高級參數
| 參數 | 是否必選 | 說明 |
|---|---|---|
| 節點執行的最長時間 | 是 | 設置節點執行的超時時間,如果節點配置了重試,在超時時間內未執行完成,該節點將不會再重試,直接置為失敗狀態。 |
| 失敗重試 | 是 | 節點執行失敗后,是否重新執行節點。 是:重新執行節點,請配置以下參數。 ? 最大重試次數 ? 重試間隔時間(秒) 否:默認值,不重新執行節點。 說明 如果作業節點配置了重試,并且配置了超時時間,該節點執行超時后將不會再重試,直接置為失敗狀態。 |
| 失敗策略 | 是 | 節點執行失敗后的操作: 終止當前作業執行計劃:停止當前作業運行,當前作業實例狀態顯示為“失敗”。 繼續執行下一節點:忽略當前節點失敗,當前作業實例狀態顯示為“忽略失敗成功”。 掛起當前作業執行計劃:暫停當前作業運行,當前作業實例狀態顯示為“等待運行”。 終止后續節點執行計劃:停止后續節點的運行,當前作業實例狀態顯示為“失敗”。 |
| 空跑 | 否 | 如果勾選了空跑,該節點不會實際執行,將直接返回成功。 |
血緣關系
| 參數 | 說明 |
|---|---|
| 輸入 | |
| 新建 | 單擊“新建”,在“類型”的下拉選項中選擇要新建的類型。可以選擇DWS,OBS,CSS,HIVE,CUSTOM和DLI類型。 DWS ? 連接名稱(必選):單擊 ![]() ,在彈出的“連接名稱”窗口選擇DWS的數據連接。? 數據庫(必選):單擊 ![]() ,在彈出的“數據庫”窗口選擇DWS的數據庫。?schema(必選):單擊 ![]() ,在彈出的“schema”窗口選擇DWS的數據庫模式。? 表名(必選):單擊 ![]() ,在彈出的“表名”窗口選擇DWS的數據表。OBS ? 路徑(必選):單擊 ![]() ,在彈出的“OBS文件瀏覽”窗口選擇OBS路徑。CSS ? 集群名稱(必選):單擊 ![]() ,在彈出的“CloudSearch集群”窗口選擇CloudSearch集群。? 索引名稱(必選):輸入CSS類型的索引名稱。 HIVE ? 連接名稱(必選):單擊 ![]() ,在彈出的“連接名稱”窗口選擇HIVE的數據連接。? 數據庫(必選):單擊 ![]() ,在彈出的“數據庫”窗口選擇HIVE的數據庫。? 表名(必選):單擊 ![]() ,在彈出的“表名”窗口選擇HIVE的數據表。CUSTOM ? 名稱(必選):輸入CUSTOM類型的名稱。 ? 屬性(必選):輸入CUSTOM類型的屬性,可新增不止一條。 DLI ? 連接名稱(必選):單擊 ![]() ,在彈出的“連接名稱”窗口選擇DLI的數據連接。? 數據庫(必選):單擊 ![]() ,在彈出的“數據庫”窗口選擇DLI的數據庫。? 表名(必選):單擊 ,在彈出的“表名”窗口選擇DLI的數據表。 |
| 確定 | 單擊“確認”,保存節點輸入功能的參數配置。 |
| 取消 | 單擊“取消”,取消節點輸入功能的參數配置。 |
| 編輯 | 單擊![]() ,修改節點輸入功能的參數配置,修改完成后,請保存。 |
| 刪除 | 單擊![]() ,刪除節點輸入功能的參數配置。 |
| 查看表詳情 | 單擊![]() ,查看節點輸入血緣關系創建數據表的詳細信息。 |
| 輸出 | |
| 新建 | 單擊“新建”,在“類型”的下拉選項中選擇要新建的類型。可以選擇DWS,OBS,CSS,HIVE,CUSTOM和DLI類型。 DWS ? 連接名稱(必選):單擊 ![]() ,在彈出的“連接名稱”窗口選擇DWS的數據連接。? 數據庫(必選):單擊 ![]() ,在彈出的“數據庫”窗口選擇DWS的數據庫。? schema(必選):單擊 ![]() ,在彈出的“schema”窗口選擇DWS的數據庫模式。? 表名(必選):單擊 ![]() ,在彈出的“表名”窗口選擇DWS的數據表。OBS ? 路徑(必選):單擊 ![]() ,在彈出的“OBS文件瀏覽”窗口選擇OBS路徑。CSS ? 集群名稱(必選):單擊 ![]() ,在彈出的“CloudSearch集群”窗口選擇CloudSearch集群。? 索引名稱(必選):輸入CSS類型的索引名稱。 HIVE ? 連接名稱(必選):單擊 ![]() ,在彈出的“連接名稱”窗口選擇HIVE的數據連接。? 數據庫(必選):單擊 ![]() ,在彈出的“數據庫”窗口選擇HIVE的數據庫。? 表名(必選):單擊 ![]() ,在彈出的“表名”窗口選擇HIVE的數據表。CUSTOM ? 名稱(必選):輸入CUSTOM類型的名稱。 ? 屬性(必選):輸入CUSTOM類型的屬性,可新增不止一條。 DLI ? 連接名稱(必選):單擊 ![]() ,在彈出的“連接名稱”窗口選擇DLI的數據連接。? 數據庫(必選):單擊 ![]() ,在彈出的“數據庫”窗口選擇DLI的數據庫。? 表名(必選):單擊 ![]() ,在彈出的“表名”窗口選擇DLI的數據表。 |
| 確定 | 單擊“確認”,保存節點輸出功能的參數配置。 |
| 取消 | 單擊“取消”,取消節點輸出功能的參數配置。 |
| 編輯 | 單擊![]() ,修改節點輸出功能的參數配置,修改完成后,請保存。 |
| 刪除 | 單擊![]() ,刪除節點輸出功能的參數配置。 |
| 查看表詳情 | 單擊![]() ,查看節點輸出血緣關系創建數據表的詳細信息。 |

,添加請求消息頭,參數說明如下:
,在彈出的“連接名稱”窗口選擇DWS的數據連接。
,在彈出的“數據庫”窗口選擇DWS的數據庫。?
,在彈出的“schema”窗口選擇DWS的數據庫模式。
,在彈出的“表名”窗口選擇DWS的數據表。
,在彈出的“OBS文件瀏覽”窗口選擇OBS路徑。
,在彈出的“CloudSearch集群”窗口選擇CloudSearch集群。
,在彈出的“連接名稱”窗口選擇HIVE的數據連接。
,在彈出的“數據庫”窗口選擇HIVE的數據庫。
,在彈出的“表名”窗口選擇HIVE的數據表。
,在彈出的“連接名稱”窗口選擇DLI的數據連接。
,在彈出的“數據庫”窗口選擇DLI的數據庫。
,在彈出的“表名”窗口選擇DLI的數據表。
,修改節點輸入功能的參數配置,修改完成后,請保存。
,刪除節點輸入功能的參數配置。
,查看節點輸入血緣關系創建數據表的詳細信息。
,在彈出的“連接名稱”窗口選擇DWS的數據連接。
,在彈出的“數據庫”窗口選擇DWS的數據庫。
,在彈出的“schema”窗口選擇DWS的數據庫模式。
,在彈出的“表名”窗口選擇DWS的數據表。
,在彈出的“OBS文件瀏覽”窗口選擇OBS路徑。
,在彈出的“CloudSearch集群”窗口選擇CloudSearch集群。
,在彈出的“連接名稱”窗口選擇HIVE的數據連接。
,在彈出的“數據庫”窗口選擇HIVE的數據庫。
,在彈出的“表名”窗口選擇HIVE的數據表。
,在彈出的“連接名稱”窗口選擇DLI的數據連接。
,在彈出的“數據庫”窗口選擇DLI的數據庫。
,在彈出的“表名”窗口選擇DLI的數據表。
,修改節點輸出功能的參數配置,修改完成后,請保存。
,刪除節點輸出功能的參數配置。
,查看節點輸出血緣關系創建數據表的詳細信息。