ListLiveRecordTemplates-阿里云帮助中心

Call ListLiveRecordTemplates to retrieve a list of your real-time recording templates.

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

ice:ListLiveRecordTemplates

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword to search for templates by ID or name. Fuzzy matching is supported for template names.	test template
Type	string	No	The template type. Valid values: system : System-defined custom : Custom	custom
TemplateIds	array	No	The template IDs to retrieve.
	string	No	The template ID.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
PageNo	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Value range: 1–100. Default value: 10.	10
SortBy	string	No	The sort order. The default sort is descending by creation time. Valid values: asc : Ascending desc : Descending (default)	desc

Response elements

Element	Type	Description	Example
	object	The response object.
RecordTemplateList	array<object>	The list of recording templates.
	array<object>	The recording template.
Name	string	The template name.	test template
Type	string	The template type.	custom
LastModified	string	The time 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.
	object	The recording format.
Format	string	The recording file format.	m3u8
SliceDuration	integer	The duration of each slice, in seconds.	30
OssObjectPrefix	string	The object prefix for the recording file stored in Object Storage Service (OSS).	record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}
SliceOssObjectPrefix	string	The object prefix for the Transport Stream (TS) slice.	record/{JobId}/{UnixTimestamp}_{Sequence}
CycleDuration	integer	The duration of the recording cycle, in seconds.	21600
CreateTime	string	The time the template was created.	2022-07-20T02:48:58Z
RequestId	string	The request ID.	BEA98A0C-7870-15FE-B96F-8880BB600A2C
TotalCount	integer	The total number of templates.	5
PageNo	integer	The page number.	1
PageSize	integer	The number of templates per page.	10
SortBy	string	The sort order. By default, templates are sorted by creation time in descending order. Valid values: asc : Ascending order desc : Descending order (default value)	desc

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.