查询字幕规则列表。
接口说明
本接口支持查询字幕规则列表信息,调用时请保证参数设置符合要求。
当前实时字幕功能处于邀测阶段,单个用户最多可添加 300 个字幕模板。
QPS 限制
本接口的单用户 QPS 限制为 60 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:DescribeLiveAIProduceRules |
create |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
Domain |
string |
否 |
主播放域名。 |
demo.aliyundoc.com |
App |
string |
否 |
播流所属应用名称。 |
AppName |
SuffixName |
string |
否 |
字幕后缀。 说明
传值为 SubtitleName 字幕模板名称设置的值。 |
sub01 |
RulesId |
string |
否 |
字幕规则 ID。 |
445409ec-7eaa-461d-8f29-4bec**** |
PageNumber |
string |
否 |
分⻚的⻚数,取值范围【1,100】。 |
1 |
PageSize |
string |
否 |
分⻚每⻚个数,取值范围【1,100】。 |
100 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
5c6a2a0df228-4a64- af62-20e91b96**** |
RuleInfoList |
object |
||
RuleInfo |
array<object> |
字幕规则列表。 |
|
object |
字幕规则对象。 |
||
Domain |
string |
播流域名。 |
demo.aliyundoc.com |
App |
string |
播流所属应用名称。 |
App Name |
SubtitleName |
string |
字幕模板名称。 |
sub1 |
IsLazy |
boolean |
是否拉流触发。 |
true |
RulesId |
string |
字幕规则 ID。 |
72fba656-2cc2-40fd-923c-2a10c3b9**** |
LiveTemplate |
string |
字幕输出规格。 |
lp_ld |
GmtModifyTime |
string |
最近修改时间(时间戳)。 |
1715594344000 |
SuffixName |
string |
字幕后缀。 |
test0506 |
StudioName |
string |
虚拟背景模板名称 |
test0708 |
Description |
string |
规则描述。 |
live AI subtitle template |
示例
正常返回示例
JSON
格式
{
"RequestId": "5c6a2a0df228-4a64- af62-20e91b96****",
"RuleInfoList": {
"RuleInfo": [
{
"Domain": "demo.aliyundoc.com",
"App": "App Name",
"SubtitleName": "sub1",
"IsLazy": true,
"RulesId": "72fba656-2cc2-40fd-923c-2a10c3b9****",
"LiveTemplate": "lp_ld",
"GmtModifyTime": "1715594344000",
"SuffixName": "test0506",
"StudioName": "test0708",
"Description": "live AI subtitle template"
}
]
}
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | MissingParameter | %s. | 参数缺失 |
400 | InvalidParameter | %s. | 参数错误 |
400 | IncorrectSubtitleStatus.%s | %s. | 字幕模版状态异常 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。