魔筆平臺提供了強大的阿里云 OSS 集成功能,允許用戶通過簡單的配置,實現對阿里云 OSS 接口的無縫連接和數據交互。本文檔將指導您如何創建和使用阿里云 OSS 集成。
功能介紹
魔筆平臺的阿里云 OSS 集成功能支持以下特點:
自定義觸發方式:集成操作可以設置為手動觸發或自動運行,滿足不同的業務場景需求。
回調和數據轉換:支持在查詢成功或失敗時執行特定的集成操作事件,以及對返回的數據進行自定義處理。
高級設置:提供防抖和禁止執行條件的高級配置,以優化集成操作的執行。
事件相關內容可參考:集成操作事件
使用阿里云 OSS 集成
步驟 1:創建阿里云 OSS 集成
登錄魔筆平臺,進入管控臺。
導航至“資源”->“集成”,點擊“創建集成”。
選擇“阿里云 OSS”,并填寫集成名稱及描述。
配置不同環境的阿里云 OSS 集成信息,包括
區域
、Bucket 名稱
和訪問密鑰
等。點擊“確定”創建阿里云 OSS 集成。
步驟 2:在應用內部創建集成操作
打開“代碼”面板,點擊對應作用域的“+”后選中“集成操作”。
選擇之前創建的阿里云 OSS 集成作為資源,選擇操作類型后會展開該操作類型下的所有參數,配置參數后點擊運行獲取返回結果。
點擊“運行”預覽查詢效果。
配置面板詳解
集成配置
關于阿里云 OSS 請參考什么是對象存儲 OSS。
區域:定義了阿里云 OSS 的 Bucket 存儲數據的區域。關于 Bucket 的空間地域,可以參考存儲空間地域屬性。
Bucket 名稱:定義了阿里云 OSS 存儲空間的名稱。關于 Bucket 名稱,可以參考存儲空間命名
訪問密鑰:定義了預期發起 OpenAPI 請求所使用的訪問密鑰,關于訪問密鑰,可以參考創建AccessKey。
角色 ARN:目標RAM角色的 ARN(Aliyun Resource Name,阿里云資源名稱),分片上傳時必填。關于創建角色,可以參考創建可信實體為阿里云賬號的 RAM 角色。關于查看角色 ARN,可以參考查看 RAM 角色。
通用配置
獲取分片上傳憑證: 操作類型為
獲取分片上傳憑證
時,需要填寫要上傳的目錄(為空時默認使用根目錄)和訪問權限(為空時默認使用集成 Bucket 訪問權限)。推薦在傳輸大文件(超過 5 GB)時,使用分片上傳。重要獲取分片上傳憑證
必須要在集成配置中填寫角色 ARN
參數,否則無法使用。請注意目錄的命名格式,不要以正斜線/
或反斜線\
開頭,不要出現連續的正斜線/
。詳情請參考管理目錄。獲取表單上傳:操作類型為
獲取表單上傳憑證
時,需要填寫要上傳的目錄(為空時默認使用根目錄)和訪問權限(為空時默認使用集成 Bucket 訪問權限)。推薦在傳輸小文件(不超過 5 GB)時,使用表單上傳。重要表單上傳不支持上傳超過 5 GB 的文件。
獲取文件 URL: 操作類型為
獲取文件 URL
時,需要填寫要獲取的文件的完整路徑(完整路徑不包含 Bucket 名稱),如果該文件的訪問權限為私有,則根據過期時間參數(為空則默認 300 秒)獲取該文件的加簽 URL,否則獲取該文件的公開 URL。關于文件的權限,可以參考設置Object ACL。- 說明
OSS 集成操作
獲取分片上傳憑證
與獲取表單上傳憑證
請與上傳組件一起使用以實現將文件上傳到阿里云 OSS。重要使用文件上傳功能時,請確保您的 Bucket 允許跨域來源。在使用分片上傳時,請在暴露 Headers 中設置
Etag
。關于跨域設置,可以參考跨域設置。
回調配置
數據轉化:對接口返回的數據進行處理,默認為
return data
,即不進行處理。成功回調:配置接口調用成功時觸發的事件。
失敗回調:配置接口調用失敗時觸發的事件。
高級配置
防抖:設置防抖表達式,避免接口的頻繁調用。
禁止執行條件:根據條件表達式確定是否執行此集成操作。
手動觸發集成
事件觸發
在需要觸發集成操作的組件中,配置事件處理器。
將動作類型設置為集成操作,并選擇相應的集成。
以對象形式填寫已配置的參數。
API 觸發
若此集成操作的名稱為action1
,則在任何可以執行腳本的地方,可以使用action1.trigger()
方法觸發集成操作,若集成操作配置了參數,則需要以對象形式填寫已配置的參數。