调用DescribeAutoLiveStreamRule查询自动旁路单路转推规则

使用说明

调用本接口前，您必须已经调用CreateAutoLiveStreamRule创建旁路规则。

QPS限制

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

调试

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

调试

请求参数

名称	类型	是否必选	示例值	描述


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeAutoLiveStreamRule	系统规定参数。取值：DescribeAutoLiveStreamRule。
AppId	String	是	eo85****	应用ID，可通过控制台创建和查询。

返回数据

名称	类型	示例值	描述


名称	类型	示例值	描述
RequestId	String	069BCB66-CD80-11E8-A82B-A70F78BBDC00	请求ID。
Rules	Array of Rule		规则详情。
Status	String	disable	规则状态，取值： enable：启用。 disable：停用。
MediaEncode	Integer	20	编码选项。
PlayDomain	String	rtmp://${domain}/${app}/${stream}	自动旁路的播流域名。
CallBack	String	http://example.com/callBack	回调地址。
CreateTime	String	2021-08-19T02:53:07Z	规则创建时间。
RuleId	Long	12	规则ID。
RuleName	String	testRule	规则名称。
ChannelIds	Array of String	12333	精确匹配的频道ID。
ChannelIdPrefixes	Array of String	12	模糊匹配频道ID的前缀。

示例

请求示例

http(s)://rtc.aliyuncs.com/?Action=DescribeAutoLiveStreamRule
&AppId=eo85****
&公共请求参数

正常返回示例

XML格式

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

<DescribeAutoLiveStreamRuleResponse>
    <RequestId>069BCB66-CD80-11E8-A82B-A70F78BBDC00</RequestId>
    <Rules>
        <Status>disable</Status>
        <CallBack/>
        <PlayDomain>rtmp://${domain}/${app}/${stream}</PlayDomain>
        <RuleId>12</RuleId>
        <CreateTime>2021-08-19T02:53:07Z</CreateTime>
        <MediaEncode/>
        <RuleName>testRule</RuleName>
    </Rules>
</DescribeAutoLiveStreamRuleResponse>

JSON格式

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

{
  "RequestId" : "069BCB66-CD80-11E8-A82B-A70F78BBDC00",
  "Rules" : [ {
    "Status" : "disable",
    "ChannelIdPrefixes" : [ ],
    "CallBack" : "",
    "PlayDomain" : "rtmp://${domain}/${app}/${stream}",
    "RuleId" : 12,
    "CreateTime" : "2021-08-19T02:53:07Z",
    "MediaEncode" : "",
    "RuleName" : "testRule",
    "ChannelIds" : [ ]
  } ]
}