Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to query a live recording template.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeLiveRecordTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Definitions.N | No | Array of Integer | Filter condition for the unique identifier of the recording template. The array can contain up to 100 unique identifiers. |
| Offset | No | Integer | Pagination offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
| Type | No | String | Condition for filtering templates by type. If this field is not specified, all templates are returned. Available values: * Preset: system preset template * Custom: user-defined template. |
| Name | No | String | Filter condition for recording template identifiers, with a length limit of 64 characters. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of records that meet the filtering conditions. |
| LiveRecordTemplateSet | Array of LiveRecordTemplate | Recording template details list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Search for a live recording template
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLiveRecordTemplates
<Common request parameters>
{
"Definitions": [
20001
]
}
{
"Response": {
"TotalCount": 1,
"LiveRecordTemplateSet": [
{
"Definition": 20001,
"HLSConfigure": {
"ItemDuration": 10,
"Interval": 3600
},
"Name": "Template 1",
"Comment": "",
"Type": "Preset",
"CreateTime": "2023-05-04T10:00:00Z",
"UpdateTime": "2023-05-04T10:00:00Z"
}
],
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InternalError.AccessDBError | Data error. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.Limit | Parameter error: Limit. |
文档反馈