GetEventCallback - 获取事件回调

更新时间:
复制为 MD 格式

调用GetEventCallback获取事件回调配置。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:GetEventCallback

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

******11-DB8D-4A9A-875B-275798******

CallbackType

string

回调方式,取值:

  • HTTP

  • MNS

回调方式说明,详情请参见回调方式说明

枚举值:

  • MNS :

    MNS

  • HTTP :

    HTTP

HTTP

CallbackQueueName

string

回调 MNS 队列名称。

ice-callback-queue

CallbackURL

string

事件通知回调地址。

http://xxx.yyy/callback

EventTypeList

string

回调事件类型,多值以逗号分隔。事件类型参考 事件通知内容

ProduceMediaComplete,TranscodeComplete

AuthSwitch

string

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

  • on(启用)

  • off(不启用)

枚举值:

  • off :

    off

  • on :

    on

on

AuthKey

string

回调方式选择 HTTP 时,鉴权 Key。

TestKey001

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "CallbackType": "HTTP",
  "CallbackQueueName": "ice-callback-queue",
  "CallbackURL": "http://xxx.yyy/callback",
  "EventTypeList": "ProduceMediaComplete,TranscodeComplete",
  "AuthSwitch": "on",
  "AuthKey": "TestKey001"
}

错误码

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

变更历史

更多信息,参考变更详情