DescribeLiveAIProduceRules - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries a list of caption rules.

Operation description

This operation queries a list of caption rules. Before you call this operation, ensure that the parameters are correctly configured.

Important

The real-time caption feature is in invitational preview. Each user can add a maximum of 300 caption templates.

QPS limit

The queries per second (QPS) limit for a single user is 60. Exceeding this limit results in API call throttling, which can affect your business. We recommend that you call this operation at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeLiveAIProduceRules

create

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Domain	string	No	The primary playback domain name.	demo.aliyundoc.com
App	string	No	The name of the application to which the stream belongs.	AppName
SuffixName	string	No	The caption suffix. Note Set this parameter to the value of SubtitleName that is specified for the caption template.	sub01
RulesId	string	No	The ID of the caption rule.	445409ec-7eaa-461d-8f29-4bec****
PageNumber	string	No	The page number. Valid values: 1 to 100.	1
PageSize	string	No	The number of entries per page. Valid values: 1 to 100.	100

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	5c6a2a0df228-4a64- af62-20e91b96****
RuleInfoList	object
RuleInfo	array<object>	The list of caption rules.
	object	The caption rule object.
Domain	string	The streaming domain.	demo.aliyundoc.com
App	string	The name of the application to which the stream belongs.	App Name
SubtitleName	string	The name of the caption template.	sub1
IsLazy	boolean	Indicates whether the rule is triggered by stream pulling.	true
RulesId	string	The ID of the caption rule.	72fba656-2cc2-40fd-923c-2a10c3b9****
LiveTemplate	string	The specifications of the output captions.	lp_ld
GmtModifyTime	string	The last modification time. This is a UNIX timestamp.	1715594344000
SuffixName	string	The caption suffix.	test0506
StudioName	string	The name of the virtual background template.	test0708
Description	string	The description of the rule.	live AI subtitle template

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter	%s.	Parameter error
400	IncorrectSubtitleStatus.%s	%s.	Abnormal subtitle template status

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.