呼叫 REST 端點工作

「呼叫 REST 端點」工作可讓您從整合作業呼叫任何第三方 REST API。您會在整合變數中使用來自 REST API 呼叫的回應，可用於其他下游任務。

事前準備

如要連線至 REST API 呼叫的驗證端點，請確認您已建立 OAuth 2.0 設定檔，或將使用者管理的服務帳戶附加至整合。如果 API 不需要驗證，工作設定窗格中的「驗證設定檔」欄位可以留空。如要查看設定清單，請參閱「設定屬性」。
如果您的整合服務同時設定了 OAuth 2.0 設定檔和使用者管理的服務帳戶，系統預設會使用 OAuth 2.0 設定檔進行驗證。如果未設定 OAuth 2.0 設定檔和使用者管理的服務帳戶，執行作業就會失敗。
如果整合服務已附加服務帳戶，請根據 REST 端點網址，授予該服務帳戶必要的 IAM 角色。舉例來說，如果 REST 端點網址呼叫 Cloud Storage 服務，請授予 Cloud Storage 服務所需的 IAM 角色。
如要瞭解如何將角色授予服務帳戶，請參閱「管理服務帳戶的存取權」一文。
確認專案中 Google Cloud 的 Application Integration未設定 VPC Service Controls。
警告：如果為 Google Cloud 專案中的 Application Integration 設定 VPC Service Controls，Cloud Function 將無法運作或停止運作。

設定「呼叫 REST 端點」工作

如要設定「呼叫 REST 端點」工作，請按照下列步驟操作：

前往 Google Cloud 控制台的「Application Integration」頁面。
前往「Application Integration」
在導覽選單中，按一下「整合」。
系統隨即會顯示「整合」頁面，列出 Google Cloud 專案中可用的所有整合功能。
選取現有整合，或按一下「建立整合」建立新整合。
如要建立新的整合項目：
1. 在「建立整合」窗格中輸入名稱和說明。
2. 選取整合作業的區域。
  注意：「區域」下拉式選單只會列出 Google Cloud 專案中佈建的區域。如要佈建新區域，請按一下「啟用區域」。詳情請參閱「啟用新區域」。
3. 選取整合的服務帳戶。如要變更或更新整合的服務帳戶詳細資料，請隨時前往整合工具列的「整合摘要」窗格。
  注意：只有在您為所選區域啟用整合控管功能時，系統才會顯示選取服務帳戶的選項。
4. 按一下「Create」(建立)。新建立的整合服務會在整合服務編輯器中開啟。
在整合編輯器的導覽列中，按一下「Tasks」(工作)，即可查看可用工作和連結器的清單。
在整合服務編輯器中，按一下並放置「Call REST Endpoint」(呼叫 REST 端點) 元素。
按一下設計工具中的「Call REST Endpoint」(呼叫 REST 端點) 元素，即可查看「Call REST Endpoint」(呼叫 REST 端點) 任務設定窗格。
使用工作設定屬性設定顯示的欄位，詳情請參閱下表。
系統會自動儲存屬性變更。

注意：如果您更新「呼叫 REST 端點」工作的驗證設定檔，並在未發布變更的情況下測試整合，整合會使用舊的驗證設定檔。為確保整合項目使用更新後的驗證設定檔，您必須先發布整合項目，再進行測試。

設定屬性

下表說明「Call REST Endpoint」(呼叫 REST 端點) 任務的設定屬性。

屬性	資料類型	說明
標籤	字串	選用：為工作新增標籤。
驗證	字串	選用：設定及儲存連線至外部系統的驗證詳細資料。詳情請參閱「在 Application Integration 中建立驗證設定檔」。
端點基準網址	String	不含查詢參數的 REST 端點網址。
HTTP 方法	NA	要使用的 HTTP 方法。您可以選取下列任一 HTTP 方法： DELETE GET HEAD PATCH POST PUT
網址查詢字串參數	查詢字串鍵：字串值：字串	REST API 呼叫所需的查詢參數。查詢參數為鍵/值組合，其中鍵是鍵名，值則是對應的鍵值。按一下加號圖示，即可輸入多個鍵/值組合。
HTTP 標頭	HTTP 標頭鍵：String 值：字串	REST API 呼叫所需的 HTTP 標頭。 HTTP 標頭採用鍵/值組合的形式，其中鍵是鍵名，值則是對應的鍵值。按一下加號圖示，即可輸入多個鍵/值組合。
遵循重新導向	Boolean	追蹤網址重新導向。你可以選取下列任一值： True ：如果端點基準網址轉送至其他網址，則呼叫重新導向的網址。 False：如果端點基準網址轉送至其他網址，則不會呼叫重新導向的網址。
工作應因 HTTP 錯誤而失敗	Boolean	REST API 呼叫失敗時的例外狀況處理策略。如果 HTTP 回應碼為 `4xx` 或 `5xx`，呼叫 REST 端點就會失敗。如需錯誤代碼清單，請參閱「錯誤代碼」。如果是其他 HTTP 回應代碼，請在回覆中傳回錯誤代碼和錯誤訊息。注意：如果錯誤與 REST API 呼叫無關 (例如網址不正確)，無論此選項設定為何，工作一律會失敗。您可以選取下列任一值： True ：擲回例外狀況。 False：不會擲回例外狀況。但會在回應中傳回錯誤代碼和錯誤訊息。
回應標頭 (<工作名稱>)	String	REST API 回應中未壓縮的回應標頭。
回應主體 (<工作名稱>)	String	REST API 回應中未壓縮的回應本文。
回應狀態 (<工作名稱>)	String	REST API 回應中的 HTTP 回應碼和對應的程式碼文字。

最佳做法

如要瞭解 Call REST Endpoint 工作適用的用量限制，請參閱用量限制。

錯誤處理策略

工作錯誤處理策略會指定工作因暫時性錯誤而失敗時，系統應採取的動作。如要瞭解如何使用錯誤處理策略，以及不同類型的錯誤處理策略，請參閱「錯誤處理策略」。

如要瞭解如何處理 4xx 或 5xx 錯誤的重試策略，請參閱「How to retry Rest Caller Task based on Response Status」網誌。

配額與限制

如要瞭解配額和限制，請參閱配額和限制。