DescribeLiveAIProduceRules - ApsaraVideo Live

Usage notes

You can call this operation to query the subtitle rules. Make sure that the parameter configurations meet the requirements.

Important The live subtitles feature is in invitational preview. You can add up to 300 subtitle templates.

QPS limit

You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically generates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveAIProduceRules	The operation that you want to perform. Set the value to DescribeLiveAIProduceRules.
Domain	String	No	demo.aliyundoc.com	The main streaming domain.
App	String	No	AppName	The name of the application to which the live stream belongs.
SuffixName	String	No	sub01	The suffix of the subtitle rule. Note Set the value to the name of the subtitle template.
RulesId	String	No	445409ec-7eaa-461d-8f29-4bec****	The ID of the subtitle rule.
PageNumber	String	No	1	The page number. Valid values: [1,100].
PageSize	String	No	100	The number of entries per page. Valid values: [1,100].

Response parameters

Parameter	Type	Example	Description
RequestId	String	5c6a2a0df228-4a64- af62-20e91b96****	The ID of the request.
RuleInfoList	Array of RuleInfo		The subtitle rules.
RuleInfo
Domain	String	demo.aliyundoc.com	The streaming domain.
App	String	App Name	The name of the application to which the live stream belongs.
SubtitleName	String	sub1	The name of the subtitle template.
IsLazy	Boolean	true	Indicates whether the rule takes effect when stream pulling starts.
IsOrigin	Boolean	true	Indicates whether the source stream is replaced.
RulesId	String	72fba656-2cc2-40fd-923c-2a10c3b9****	The ID of the subtitle rule.
LiveTemplate	String	lp_ld	The specification of the exported subtitles.
GmtModifyTime	String	1715594344000	The last time when the rule was modified. The value is a timestamp.
SuffixName	String	test0506	The suffix of the subtitle rule.
Description	String	live AI subtitle template	The description of the rule.

Examples

Sample requests

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
&<Common request parameters>

Sample success responses

XML format

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 format

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"
  } ]
}

Error codes

HttpCode	Error code	Error message	Description
400	MissingParameter	%s.	One or more required parameters are missing.
400	InvalidParameter	%s.	One or more parameters are invalid.
400	IncorrectSubtitleStatus.%s	%s.	The status of the subtitle template is abnormal.

For a list of error codes, see Service error codes.