設置特定事件的通知機制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| ice:SetEventCallback | update | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CallbackType | string | 否 | 回調方式，取值：
| HTTP |
| CallbackQueueName | string | 否 | 所在區域的 MNS 隊列名稱，必須以 ice-callback- 開頭 | ice-callback-queue |
| CallbackURL | string | 否 | 回調地址。回調方式為 HTTP 時，需設置此參數。 回調地址 URL 的長度不能超過 256 個字節，不支持設置多個回調地址。 | http://xxx.yyy/callback |
| EventTypeList | string | 否 | 回調事件類型, 支持多值，以逗號分隔。 ProduceMediaComplete：剪輯合成作業完成 | ProduceMediaComplete |
| AuthSwitch | string | 否 | HTTP 回調的鑒權開關，回調方式設置為 HTTP 時，此參數有效。取值：
| on |
| AuthKey | string | 否 | 鑒權 Key，最長 32 位，必須同時包含大小寫字母和數字。回調方式為 HTTP 時，可設置此參數。 | TestKey001 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2021-06-25 | 新增 OpenAPI | 查看變更詳情 |