查询字幕规则 - 视频直播

使用说明

本接口支持查询字幕规则列表信息，调用时请保证参数设置符合要求。

重要当前实时字幕功能处于邀测阶段，单个用户最多可添加300个字幕模板。

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeLiveAIProduceRules	系统规定参数。取值：DescribeLiveAIProduceRules。
Domain	String	否	demo.aliyundoc.com	主播放域名。
App	String	否	AppName	播流所属应用名称。
SuffixName	String	否	sub01	字幕后缀。说明传值为SubtitleName字幕模板名称设置的值。
RulesId	String	否	445409ec-7eaa-461d-8f29-4bec****	字幕规则ID。
PageNumber	String	否	1	分⻚的⻚数，取值范围【1,100】。
PageSize	String	否	100	分⻚每⻚个数，取值范围【1,100】。

返回数据

名称	类型	示例值	描述
RequestId	String	5c6a2a0df228-4a64- af62-20e91b96****	请求ID。
RuleInfoList	Array of RuleInfo		字幕规则列表。
RuleInfo
Domain	String	demo.aliyundoc.com	播流域名。
App	String	App Name	播流所属应用名称。
SubtitleName	String	sub1	字幕模板名称。
IsLazy	Boolean	true	是否拉流触发。
IsOrigin	Boolean	true	是否替换原始流。
RulesId	String	72fba656-2cc2-40fd-923c-2a10c3b9****	字幕规则ID。
LiveTemplate	String	lp_ld	字幕输出规格。
GmtModifyTime	String	1715594344000	最近修改时间（时间戳）。
SuffixName	String	test0506	字幕后缀。
Description	String	live AI subtitle template	规则描述。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveAIProduceRules
&Domain=demo.aliyundoc.com
&App=AppName
&SuffixName=sub01
&RulesId=445409ec-7eaa-461d-8f29-4bec****
&PageNumber=1
&PageSize=100
&公共请求参数

正常返回示例

XML格式

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

<DescribeLiveAIProduceRulesResponse>
    <RequestId>5c6a2a0df228-4a64- af62-20e91b96****</RequestId>
    <RuleInfoList>
        <Domain>demo.aliyundoc.com</Domain>
        <App>App Name</App>
        <SubtitleName>sub1</SubtitleName>
        <IsLazy>true</IsLazy>
        <IsOrigin>true</IsOrigin>
        <RulesId>72fba656-2cc2-40fd-923c-2a10c3b9****</RulesId>
        <LiveTemplate>lp_ld</LiveTemplate>
        <GmtModifyTime>1715594344000</GmtModifyTime>
        <SuffixName>test0506</SuffixName>
        <Description>live AI subtitle template</Description>
    </RuleInfoList>
</DescribeLiveAIProduceRulesResponse>

JSON格式

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

{
  "RequestId" : "5c6a2a0df228-4a64- af62-20e91b96****",
  "RuleInfoList" : [ {
    "Domain" : "demo.aliyundoc.com",
    "App" : "App Name",
    "SubtitleName" : "sub1",
    "IsLazy" : true,
    "IsOrigin" : true,
    "RulesId" : "72fba656-2cc2-40fd-923c-2a10c3b9****",
    "LiveTemplate" : "lp_ld",
    "GmtModifyTime" : "1715594344000",
    "SuffixName" : "test0506",
    "Description" : "live AI subtitle template"
  } ]
}

错误码

HttpCode	错误码	错误信息	描述
400	MissingParameter	%s.	参数缺失
400	InvalidParameter	%s.	参数错误
400	IncorrectSubtitleStatus.%s	%s.	字幕模版状态异常

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