Queries subtitle rules.
Operation description
You can call this operation to query subtitle rules. Make sure that the parameter settings meet the requirements.
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.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:DescribeLiveAIProduceRules | create | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Domain | string | No | The main streaming domain. | demo.aliyundoc.com |
| App | string | No | The name of the application to which the live stream belongs. | AppName |
| SuffixName | string | No | The suffix of the subtitle rule. Note
Set the value to the name of the subtitle template.
| sub01 |
| RulesId | string | No | The ID of the subtitle rule. | 445409ec-7eaa-461d-8f29-4bec**** |
| PageNumber | string | No | The page number. Valid values: [1,100]. | 1 |
| PageSize | string | No | The number of entries per page. Valid values: [1,100]. | 100 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-07-04 | The Error code has changed. The response structure of the API has changed | View Change Details |