GetLiveRecordTemplate - - Alibaba Cloud Documentation Center

Queries the information about a live stream recording template or a snapshot of the template.

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:GetLiveRecordTemplate

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The template ID.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
JobId	string	No	The ID of the recording job. You can specify the JobId parameter to retrieve the snapshot of the template used by the job.	ab0e3e76-1e9d-11ed-ba64-0c42a1b73d66

Response elements

Element	Type	Description	Example
	object	The response parameters.
RecordTemplate	object	The recording template.
RecordFormatList	array<object>	The list of recording formats.
	object	The recording format.
Format	string	The output file format.	m3u8
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. If you do not specify this parameter, the default value 6 hours is used.	7200
SliceDuration	integer	The duration of a single segment. Unit: seconds.	30
CreateTime	string	The time when the job was created.	2022-07-20T03:26:36Z
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
Name	string	The template name.	test template
Type	string	The type of the template. Valid values: system custom Valid values: system : system custom : custom	custom
RequestId	string	The request ID.	C892855F-95DF-50D6-A28C-279ABDB76810

Examples

Success response

JSON format

{
  "RecordTemplate": {
    "RecordFormatList": [
      {
        "Format": "m3u8",
        "OssObjectPrefix": "record/{JobId}/{Sequence}{EscapedStartTime}{EscapedEndTime}",
        "SliceOssObjectPrefix": "record/{JobId}/{UnixTimestamp}_{Sequence}",
        "CycleDuration": 7200,
        "SliceDuration": 30
      }
    ],
    "CreateTime": "2022-07-20T03:26:36Z",
    "LastModified": "2022-07-20T03:26:36Z",
    "TemplateId": "69e1f9fe-1e97-11ed-ba64-0c42a1b73d66",
    "Name": "test template",
    "Type": "custom"
  },
  "RequestId": "C892855F-95DF-50D6-A28C-279ABDB76810"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.