全部产品
Search
文档中心

视频直播:QuerySnapshotCallbackAuth - 查询截图回调鉴权配置

更新时间:Nov 14, 2024

查询截图回调鉴权配置信息。

接口说明

您已完成配置截图回调鉴权,配置接口请参见设置截图回调鉴权配置。 本接口支持查询主播流域名已配置的截图回调鉴权信息,调用时请保证参数设置符合要求。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

主播流域名。

example.aliyundoc.com

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD5
CallbackAuthKeystring

回调鉴权密钥。

yourkey
DomainNamestring

主播流域名。

example.aliyundoc.com
CallbackReqAuthstring

回调鉴权开关。取值:

  • yes:开启。

  • no:关闭。

yes

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD5",
  "CallbackAuthKey": "yourkey",
  "DomainName": "example.aliyundoc.com",
  "CallbackReqAuth": "yes"
}

错误码

HTTP status code错误码错误信息
400MissingParam%s
500InternalError%s

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