ListLiveRecordTemplates - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries a list of live stream recording templates.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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
ice:ListLiveRecordTemplates		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The search keyword. You can use the template ID or name as the keyword to search for templates. If you search for templates by name, fuzzy match is supported.	test template
Type	string	No	The type of the template. Valid values: system custom	custom
TemplateIds	array	No
	string	No	The template ID.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
PageNo	long	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
SortBy	string	No	The sorting order. By default, the query results are sorted by creation time in descending order. Valid values: asc: sorts the query results in ascending order. desc: sorts the query results in descending order.	desc

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RecordTemplateList	array<object>	The list of recording templates.
recordTemplates	object	The recording template.
Name	string	The template name.	test template
Type	string	The type of the template.	custom
LastModified	string	The time when the template was last modified.	2022-07-20T03:26:36Z
TemplateId	string	The template ID.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
RecordFormatList	array<object>	The list of recording formats.
recordFormat	object	The recording format.
Format	string	The output file format.	m3u8
SliceDuration	integer	The duration of a single segment. Unit: seconds.	30
OssObjectPrefix	string	The name of the recording file that is stored in Object Storage Service (OSS).	record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}
SliceOssObjectPrefix	string	The name of the TS segment.	record/{JobId}/{UnixTimestamp}_{Sequence}
CycleDuration	integer	The duration of the recording cycle. Unit: seconds.	21600
CreateTime	string	The time when the job was created.	2022-07-20T02:48:58Z
RequestId	string	The request ID.	BEA98A0C-7870-15FE-B96F-8880BB600A2C
TotalCount	long	The total number of entries returned.	5
PageNo	long	The page number.	1
PageSize	long	The number of entries per page.	10
SortBy	string	The sorting order. By default, the query results are sorted by creation time in descending order. Valid values: asc: sorts the query results in ascending order. desc: sorts the query results in descending order.	desc

Examples

Sample success responses

JSONformat

{
  "RecordTemplateList": [
    {
      "Name": "test template",
      "Type": "custom",
      "LastModified": "2022-07-20T03:26:36Z",
      "TemplateId": "69e1f9fe-1e97-11ed-ba64-0c42a1b73d66",
      "RecordFormatList": [
        {
          "Format": "m3u8",
          "SliceDuration": 30,
          "OssObjectPrefix": "record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}",
          "SliceOssObjectPrefix": "record/{JobId}/{UnixTimestamp}_{Sequence}",
          "CycleDuration": 21600
        }
      ],
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ],
  "RequestId": "BEA98A0C-7870-15FE-B96F-8880BB600A2C",
  "TotalCount": 5,
  "PageNo": 1,
  "PageSize": 10,
  "SortBy": "desc"
}

Error codes

For a list of error codes, visit the Service error codes.