DescribeLiveAIProduceRules - 查询字幕规则

调用DescribeLiveAIProduceRules查询字幕规则列表。

接口说明

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

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

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeLiveAIProduceRulescreate
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
Domainstring

主播放域名。

demo.aliyundoc.com
Appstring

播流所属应用名称。

AppName
SuffixNamestring

字幕后缀。

说明 传值为 SubtitleName 字幕模板名称设置的值。
sub01
RulesIdstring

字幕规则 ID。

445409ec-7eaa-461d-8f29-4bec****
PageNumberstring

分⻚的⻚数,取值范围【1,100】。

1
PageSizestring

分⻚每⻚个数,取值范围【1,100】。

100

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5c6a2a0df228-4a64- af62-20e91b96****
RuleInfoListarray<object>

字幕规则列表。

RuleInfoobject

字幕规则对象。

Domainstring

播流域名。

demo.aliyundoc.com
Appstring

播流所属应用名称。

App Name
SubtitleNamestring

字幕模板名称。

sub1
IsLazyboolean

是否拉流触发。

true
RulesIdstring

字幕规则 ID。

72fba656-2cc2-40fd-923c-2a10c3b9****
LiveTemplatestring

字幕输出规格。

lp_ld
GmtModifyTimestring

最近修改时间(时间戳)。

1715594344000
SuffixNamestring

字幕后缀。

test0506
StudioNamestring

虚拟背景模板名称

test0708
Descriptionstring

规则描述。

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错误码错误信息描述
400MissingParameter%s.参数缺失
400InvalidParameter%s.参数错误
400IncorrectSubtitleStatus.%s%s.字幕模版状态异常

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

变更历史

变更时间变更内容概要操作
2024-10-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情