文档

查询直播推流回调配置

更新时间:

调用DescribeLiveStreamsNotifyUrlConfig查询推流回调配置。

使用说明

调用本接口可以查询回调地址和回调鉴权信息。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveStreamsNotifyUrlConfig

系统规定参数。取值:DescribeLiveStreamsNotifyUrlConfig

DomainName String demo.aliyundoc.com

您的推流域名。

返回数据

名称

类型

示例值

描述

RequestId String 40A4F36D-A7CC-473A-88E7-154F92242566

请求ID。

LiveStreamsNotifyConfig Object

回调配置。

NotifyReqAuth String yes

是否开启鉴权。取值:

  • yes
  • no
NotifyUrl String http://guide.aliyundoc.com/notify

回调地址。

NotifyAuthKey String 123456

鉴权Key。

DomainName String demo.aliyundoc.com

您的推流域名。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsNotifyUrlConfig
&DomainName=demo.aliyundoc.com
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamsNotifyUrlConfigResponse>
    <RequestId> 40A4F36D-A7CC-473A-88E7-154F92242566</RequestId>
    <LiveStreamsNotifyConfig>
        <NotifyReqAuth>yes</NotifyReqAuth>
        <NotifyUrl>http://guide.aliyundoc.com/notify</NotifyUrl>
        <NotifyAuthKey>123456</NotifyAuthKey>
        <DomainName>demo.aliyundoc.com</DomainName>
    </LiveStreamsNotifyConfig>
</DescribeLiveStreamsNotifyUrlConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : " 40A4F36D-A7CC-473A-88E7-154F92242566",
  "LiveStreamsNotifyConfig" : {
    "NotifyReqAuth" : "yes",
    "NotifyUrl" : "http://guide.aliyundoc.com/notify",
    "NotifyAuthKey" : "123456",
    "DomainName" : "demo.aliyundoc.com"
  }
}

错误码

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

特殊错误码

错误代码

描述

HTTP 状态码

语义

InternalError

The request processing has failed due to some unknown error.

500

后台发生未知错误。

InvalidDomain.NotFound

The domain provided does not exist in our records.

404

当前账户下未查到域名。

IllegalOperation

Illegal domain operate is not permitted.

403

不支持当前操作,如:非直播类域名。

InvalidConfig.NotFound

Config does not exist.

404

当前域名下未找到回调配置。