设置特定事件的通知机制。
调试
您可以在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 | 查看变更详情 |