文档中心>云点播

控制台修改事件通知配置

最近更新时间:2020-03-31 08:15:44

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

腾讯云点播为客户提供了媒体上传、媒体管理、媒体处理等等服务,在这些服务执行过程或执行结束时,腾讯云点播也提供各种对应的事件通知,方便开发者感知服务处理状态,并做下一步的业务操作。

开发者可以通过修改事件通知通知配置接口来实现:

  • 设置接收回调通知的类型,目前有 HTTP 回调通知基于消息队列的可靠通知 2 种类型。
  • 对于 HTTP 回调通知,设置 V2、V3 版本接收事件通知的地址(都指定时两个地址都会收到通知,都不指定时则表示不采用 HTTP 回调通知的接收方式)。
  • 对具体事件服务的通知事件选择设置接收或者忽略。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyEventNotificationConfigForConsole。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
Mode String 接收事件通知的方式。默认 "PUSH" 为 HTTP 回调通知,"PULL" 为基于消息队列的可靠通知
NotificationUrlV3 String 采用 HTTP 回调通知接收方式时,用于接收 V3 版本事件通知的地址。
NotificationUrlV2 String 采用 HTTP 回调通知接收方式时,用于接收 V2 版本事件通知的地址。
UploadMediaCompleteEventSwitch String 是否接收视频上传完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
TranscodeCompleteEventSwitch String 是否接收视频转码完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
CreateSnapshotByTimeOffsetCompleteEventSwitch String 是否接收指定时间点截图完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
CreateImageSpriteCompleteEventSwitch String 是否接收视频截取雪碧图完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
ConcatMediaCompleteEventSwitch String 是否接收视频拼接完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
DeleteMediaCompleteEventSwitch String 是否接收视频删除完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设置事件通知信息

输入示例

https://vod.tencentcloudapi.com/?Action=ModifyEventNotificationConfigForConsole
&Mode=PUSH
&NotificationUrlV3=http%3a%2f%2fvcloud1200.tc.qq.com%2f1200_0a78.playlist.m3u8
&UploadMediaCompleteEventSwitch=ON
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.NotificationVersionNotSupport 事件通知版本不支持。
UnauthorizedOperation 未授权操作。