文档

SetMessageCallback - 设置事件通知配置

调用SetMessageCallback设置事件通知的回调方式、回调地址、事件类型。

接口说明

支持 HTTP 回调和 MNS 回调。详细使用说明,请参见事件通知

QPS 限制

本接口的单用户 QPS 限制为 15 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:SetMessageCallbackRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
CallbackTypestring

回调方式,取值:

  • HTTP
  • MNS
HTTP
CallbackURLstring

回调地址。回调方式为 HTTP 时,需设置此参数。 回调地址 URL 的长度不能超过 256 个字节,不支持设置多个回调地址。

http://developer.aliyundoc.com
EventTypeListstring

回调事件类型,取值为空时关闭所有消息通知,取值为 ALL 时开启全部消息通知。也可指定开启某些消息通知,多个事件类型之间使用半角逗号(,)分隔。可设置的事件类型取值范围请参见:事件类型

说明 所有 AI 相关事件即 AIMediaAuditComplete、AIMediaDNAComplete 等取值都为 AIComplete
FileUploadComplete
AuthSwitchstring

HTTP 回调的鉴权开关,回调方式设置为 HTTP 时,此参数有效。取值:

  • on(启用)
  • off(不启用)
on
AuthKeystring

鉴权 Key,最长 32 位,必须同时包含大小写字母和数字。回调方式为 HTTP 时,可设置此参数。

dsf346dvet
MnsEndpointstring

消息队列公网 Endpoint,回调方式为 MNS 时,需设置此参数。可登录消息服务控制台,单击右上角的获取 Endpoint按钮获取。更多信息,请参见 Endpoint

http://****.mns.cn-shanghai.aliyuncs.com/
MnsQueueNamestring

消息队列名称,可登录消息服务控制台,在队列列表中查看。回调方式为 MNS 时,需设置此参数。

quene_name
AppIdstring

应用 ID。不传时为系统默认应用的 ID,取固定值:app-1000000

app-1000000

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

25818875-5F78-4AF6-D7393642CA58****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈