OSS與Function Compute整合後,OSS事件能觸發相關函數執行,實現對OSS中的資料的自訂處理。本文介紹Function Compute支援的OSS觸發器的使用限制、事件類型及觸發規則。
背景資訊
OSS和Function Compute通過OSS觸發器實現無縫整合,您可以編寫函數對OSS事件進行自訂處理,當OSS捕獲到指定類型的事件後,OSS事件觸發相應的函數執行。例如,您可以設定函數來處理PutObject事件,當您調用OSS的PutObject介面上傳圖片到OSS後,相關聯的函數會自動被觸發來處理該圖片。
OSS和Function Compute整合後,您可以自由地調用各種函數處理映像或音頻資料,再把結果寫回到多種儲存服務中。整個架構中,您只需要專註於函數邏輯的編寫,系統將以即時的、可靠的、大規模並行的方式處理海量的資料。
OSS觸發器使用限制
僅EventBridge類別的OSS觸發器支援配置多個檔案首碼和檔案尾碼。
原生OSS觸發器和EventBridge類別的OSS觸發器配置的檔案首碼和檔案尾碼都不支援正則匹配。
僅EventBridge類別的OSS觸發器支援在一個Bucket內關聯超過10個以上的OSS觸發器。
一般情況下,不推薦一個Bucket下關聯10個以上的觸發器,建議您建立新的Bucket,並基於新的Bucket建立觸發器。
OSS事件定義
當OSS系統捕獲到相關事件後,會將事件資訊編碼為JSON字串,傳遞給事件處理函數。OSS事件通知格式的詳細資料,請參見訊息通知。
已支援的OSS事件定義如下表所示。一種事件類型對應一個ObjectCreated、ObjectRemoved或ObjectModified類型的API,調用某個API並執行成功後會觸發函數執行一次。
事件類型 | 事件名稱 | 說明 |
ObjectCreated | oss:ObjectCreated:PutObject | 調用PutObject介面上傳檔案。更多資訊,請參見PutObject。 |
oss:ObjectCreated:PutSymlink | 調用PutSymlink介面針對OSS上的TargetObject建立軟連結,您可以通過該軟連結訪問TargetObject。更多資訊,請參見PutSymlink。 | |
oss:ObjectCreated:PostObject | 調用PostObject介面使用HTML表單上傳檔案到指定的Bucket。更多資訊,請參見PostObject。 | |
oss:ObjectCreated:CopyObject | 調用CopyObject介面拷貝一個在OSS上已經存在的對象。更多資訊,請參見CopyObject。 | |
oss:ObjectCreated:InitiateMultipartUpload | 使用MultipartUpload模式傳輸資料前,必須先調用InitiateMultipartUpload介面來通知OSS初始化一個MultipartUpload事件。更多資訊,請參見InitiateMultipartUpload。 | |
oss:ObjectCreated:UploadPart | 初始化一個MultipartUpload事件之後,可以根據指定的對象名和Upload ID來分塊(Part)上傳資料。更多資訊,請參見UploadPart。 | |
oss:ObjectCreated:UploadPartCopy | UploadPartCopy通過從一個已存在的Object中拷貝資料來上傳一個Part。更多資訊,請參見UploadPartCopy。 | |
oss:ObjectCreated:CompleteMultipartUpload | 在將所有資料Part都上傳完成後,必須調用CompleteMultipartUpload介面來完成整個檔案的MultipartUpload。更多資訊,請參見CompleteMultipartUpload。 | |
oss:ObjectCreated:AppendObject | 調用AppendObject介面以追加寫的方式上傳檔案。更多資訊,請參見AppendObject。 | |
oss:ObjectCreated:* | 調用任何上述ObjectCreated類型的API執行成功後都會觸發函數。 | |
ObjectRemoved | oss:ObjectRemoved:DeleteObject | 調用DeleteObject介面刪除某個對象。更多資訊,請參見DeleteObject。 |
oss:ObjectRemoved:DeleteObjects | 調用DeleteMultipleObjects介面大量刪除檔案。更多資訊,請參見DeleteMultipleObjects。 | |
oss:ObjectRemoved:AbortMultipartUpload | 調用AbortMultipartUpload介面可以根據使用者提供的Upload ID終止其對應的MultipartUpload事件。更多資訊,請參見AbortMultipartUpload。 | |
ObjectModified | oss:ObjectModified:UpdateObjectMeta | 調用UpdateObjectMeta介面修改某個對象的屬性。 說明 目前,支援該事件的地區包括:華東1(杭州)、華東2(上海)、華北1(青島)、華北2(北京)、華北3(張家口)、華北5(呼和浩特)、華南1(深圳)和西南1(成都)。 |
ObjectReplication | oss:ObjectReplication:ObjectCreated | 資料複製過程涉及的寫入操作。 說明 目前,支援該事件的地區包括:華東1(杭州)、華東2(上海)、華北2(北京)、華南1(深圳)。 |
oss:ObjectReplication:ObjectModified | 資料複製過程涉及的覆蓋操作。 說明 目前,支援該事件的地區包括:華東1(杭州)、華東2(上海)、華北2(北京)、華南1(深圳)。 | |
oss:ObjectReplication:ObjectRemoved | 資料複製過程涉及的刪除操作。 說明 目前,支援該事件的地區包括:華東1(杭州)、華東2(上海)、華北2(北京)、華南1(深圳)。 |
OSS觸發器觸發規則
避免迴圈觸發
使用OSS觸發器時,請注意避免迴圈觸發。例如,一個典型的迴圈觸發情境是OSS的某個Bucket上傳檔案事件觸發函數執行,此函數執行完成後又產生了一個或多個檔案再寫回到OSS的Bucket裡,這個寫入動作又觸發了函數執行,形成了鏈狀迴圈。
為了避免迴圈觸發函數產生不必要的費用,建議您設定檔首碼或檔案尾碼,例如將觸發函數的檔案的檔案首碼設定為src
,函數執行完成後組建檔案的檔案首碼設定為dst
,產生的檔案將不會再次觸發函數。如果不設定檔案首碼和檔案尾碼,表示匹配任意檔案首碼和檔案尾碼。具體操作,請參見步驟一:建立OSS觸發器。
原生OSS觸發器觸發規則:保證語義唯一性
一個Bucket下建立的觸發器必須保證語義唯一性,即觸發事件、檔案首碼和檔案尾碼組成的語義唯一。例如,您已為某Bucket建立了觸發事件為oss:ObjectCreated:PutObject的觸發器,該觸發器的檔案首碼和檔案尾碼分別為source和zip,那麼為該Bucket新建立的觸發器是否合法的說明如下表所示。
觸發事件 | 檔案首碼 | 檔案尾碼 | 是否合法 | 解釋說明 |
oss:ObjectCreated:* | source1 | zip1 | 否 | 新建立的觸發器和已建立的觸發器的事件重合。 說明 OSS的事件oss:ObjectCreated:*是所有ObjectCreated類型事件的全集。如果某Bucket下已經建立了任意一個ObjectCreated類型事件的觸發器,將無法建立oss:ObjectCreated:*事件的觸發器。同理,如果某Bucket下已經建立了oss:ObjectCreated:*事件的觸發器,將無法建立任何ObjectCreated類型事件的觸發器。 |
oss:ObjectCreated:PutObject | source | zip | 否 | 新建立的觸發器和已建立的觸發器的檔案前尾碼均重合。 |
source | 無 | 否 | 新建立的觸發器和已建立的觸發器的檔案首碼重合,檔案尾碼不設定則包含了尾碼為zip的對象。 | |
無 | zip | 否 | 新建立的觸發器和已建立的觸發器的檔案尾碼重合,檔案首碼不設定則包含了首碼為source的對象。 | |
source1 | zip1 | 是 | 新建立的觸發器和已建立的觸發器的檔案前尾碼均不重合。 | |
source | zip1 | 是 | 新建立的觸發器和已建立的觸發器的檔案尾碼不重合。 | |
source1 | zip | 是 | 新建立的觸發器和已建立的觸發器的檔案首碼不重合。 | |
oss:ObjectCreated:PostObject | source | zip | 是 | 新建立的觸發器和已建立的觸發器的事件不同。 |
原生OSS觸發器要保證語義唯一性,所以不支援為不同的函數配置相同的OSS觸發器。
如果您希望一個OSS事件類型可以觸發不同的函數進行不同的處理,即想為不同的函數配置相同的OSS觸發器,可以建立EventBridge類別的OSS觸發器。
常見問題
相關文檔
配置觸發器
關於如何配置和使用原生OSS觸發器和EventBridge類別的OSS觸發器,請參見配置原生OSS觸發器和配置EventBridge類別的OSS觸發器。
觸發器相關問題
如果您希望查看函數的執行觸發了哪個事件,可以手動在代碼邏輯中列印事件類型日誌,具體請參見日誌記錄。
如果您希望在函數中調用另一個函數,可以使用API調用指定函數,具體請參見函數可以相互調用嗎?。