SetLiveStreamsNotifyUrlConfig - 设置推流回调通知地址配置

接口说明

本接口支持配置推流域名的回调地址及其鉴权信息。
流状态实时信息回调，可以及时通知用户推流或断流操作结果。详细信息，请参见推流回调格式说明。

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:SetLiveStreamsNotifyUrlConfig

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	是	您的推流域名。	demo.aliyundoc.com
SwitchNotifyUrl	string	否	切流信息回调 URL 地址	http://guide.aliyundoc.com/switchnotify
NotifyUrl	string	否	直播流信息推送到的 URL 地址。	http://guide.aliyundoc.com/notify
ExceptionNotifyUrl	string	否	异常事件回调地址 URL。	https://4a7e5f08.r37.cpolar.top/live/Rsssd/call-back/streamStart
NotifyReqAuth	string	否	是否开启鉴权。取值： yes：开启。如果选择取值为 yes，必须同时设置请求参数 NotifyAuthKey。 no：不开启。说明不填默认为 no。鉴权逻辑请参考下文的推流回调鉴权说明。	yes
NotifyAuthKey	string	否	鉴权 key。说明当请求参数 NotifyReqAuth 取值为 yes 时，本参数必填。取值要求： 16~64 个字符。支持大写字母、小写字母、数字。	123456

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	40A4F36D-A7CC-473A-88E7-154F92242566

示例

正常返回示例

JSON格式

{
  "RequestId": " 40A4F36D-A7CC-473A-88E7-154F92242566"
}

异常返回示例

JSON格式

{
    "Code":"InternalError",
    "HostId":"live.aliyuncs.com",
    "Message":"The request processing has failed due to some unknown error.",
    "RequestId":"6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParam	Parameter invalid.	输入参数不合法
400	ConfigAlreadyExists	Config has already exist.
400	CodeGetMainPlaybackDomainError	Failed to obtain the main playback domain name.	获取主播放域名失败。
400	CodeNotPushDomain	The domain name is not a push domain name.	该域名不是推流域名。
500	InternalError	The request processing has failed due to backend service exception.

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

变更历史

更多信息，参考变更详情。