路由到API觸發
您可以通過事件規則過濾事件,將事件路由到API端點,本文以自訂事件為例介紹將事件路由到API端點的前提條件、操作步驟和結果驗證。
前提條件
步驟一:添加自訂事件來源
-
登入事件匯流排EventBridge控制台,在左側導覽列,單擊事件匯流排。
-
在頂部功能表列,選擇地區,在事件匯流排頁面,單擊目標自訂事件匯流排名稱。
-
在左側導覽列,單擊事件來源,然後單擊添加事件來源。
-
在添加自定义事件源面板,輸入名称和描述,事件提供方選擇自訂應用,然後單擊确认。
步驟二:建立事件規則
目標服務和事件規則必須處於同一地區。
-
登入事件匯流排EventBridge控制台,在左側導覽列,單擊事件匯流排。
-
在頂部功能表列,選擇地區,在事件匯流排頁面,單擊目標匯流排名稱。
-
在左側導覽列,單擊事件規則,然後單擊建立規則。
-
在创建规则面板,完成以下操作,然後單擊创建。
-
在配置基本信息頁簽,自訂規則名称和規則描述,然後單擊下一步。
-
在配置事件模式頁簽,選擇事件源类型為自定义事件源,並選擇已建立的事件來源,然後單擊下一步。
-
在配置事件目標頁簽,配置以下資訊,然後單擊创建。
-
選擇服务类型為API 触发。
-
按照下表說明配置基礎資訊地區的資訊。
配置參數
樣本
說明
建立方式
自訂建立
支援以下兩種方式:
-
自訂建立:如果您選用此種方式,需要在當前頁面建立API端點。
-
使用已有:如果您選擇此種方式,需要您提前建立好API端點。具體操作,請參見建立API端點。
API 目標名稱
testAPI
自訂API端點名稱。
描述
無
自訂描述資訊,非必填項。
HTTP 參數
-
Parameter:Header
-
Key:
Content-Type -
Value:
multipart/form-data
Parameter支援以下三種配置方式:
-
Header:此方式是通過要求標頭傳遞元資訊。這種方式只能以索引值對的形式進行配置。
-
Body:此方式是通過請求體傳遞實際資料。這種方式支援索引值對或消息的原始数据兩種方式進行配置。
-
Query:此方式是通過URL查詢字串傳遞參數。這種方式只能以索引值對的形式進行配置。
三種Parameter配置的具體方式:
-
索引值對:Key支援部分事件、固定值或完整事件,Value同樣支援部分事件、固定值或完整事件。
-
未經處理資料:需要配置变量和模板。具體配置資訊,請參見模板。
-
-
在API 配置地區設定以下資訊。
配置項
樣本
說明
URL
https://******此URL為需要訪問服務端資源的API地址。
HTTP Method
GET
支援以下請求方式擷取服務端資源:
-
GET:請求指定的頁面資訊,並返回實體主體。
-
POST:向指定資源提交資料,請求伺服器進行處理。資料被包含在請求體中。
-
PUT:向指定資源位置上傳其最新內容。
-
PATCH:用於對資源進行部分修改。
-
DELETE:請求伺服器刪除指定的資源。
-
HEAD:類似於GET請求,但伺服器只返回狀態行和頭部資訊,不返回訊息體。
-
-
在连接配置地區設定以下資訊。
配置項
樣本
說明
配置方式
建立配置
支援以下兩種配置方式:
-
建立配置:如果您選擇此種方式,需要在當前頁面建立Connection。
-
選擇已有:如果選擇此種方式,需要您提前建立好Connection。具體操作,請參見建立Connection。
串連名稱
Connection-test
自訂Connection名稱。
串連描述
無
自訂描述資訊,非必填項。
鑒權配置
無需配置
支援以下四種鑒權配置:
-
無需配置:如果您選擇此種方式,表示任何訪問請求都會被API端點響應。
-
Basic:此種方式為基本驗證方式,如果您選擇此種方式,需要您自訂用於授權用户名和密码。
-
OAuth 用戶端憑據:此種方式是一種更加安全可靠的授權認證方式。
-
API Key:此種方式是一種比較簡單的認證方式。如果選擇此種方式,需要您自訂API訪問的KeyName和KeyValue。
網路選擇
公網
有以下兩種網路類型可以選擇:
-
公網
-
專用網路:如果您選擇此種方式,需要提前建立Virtual Private Cloud、交換器和安全性群組。
-
-
(可選):展開重试和死信地區,配置重试策略、容错策略和死信队列。具體配置資訊,請參見重試和死信。
-
-
步驟三:發布事件
-
登入事件匯流排EventBridge控制台,在左側導覽列,單擊事件匯流排。
-
在頂部功能表列,選擇地區。
-
在事件总线頁面,找到目標匯流排,在其右側操作列單擊发布事件。
說明僅自訂事件匯流排支援通過控制台發布事件。
-
在发布事件至自定义事件总线 {name}面板,自定义事件源下拉式清單選擇已建立的自訂事件來源,在事件体代碼框輸入事件內容,然後單擊确定。
說明-
事件包含的參數規範,請參見事件概述。
-
單擊确定後,會預設複製事件ID。
-
結果驗證
-
進入目標事件匯流排的概览頁面。
-
在左側導覽列單擊事件追踪,然後單擊按時間ID查詢頁簽。
-
在事件 ID對應的文字框中複製事件ID,然後單擊查询。
-
單擊目標事件操作列的事件轨迹,查看事件是否投遞成功。
在事件軌跡詳情頁,事件投遞地區顯示規則投遞狀態為成功,表示事件已成功投遞至 API Destination 目標,投遞響應為 HTTP 200。