UpdateLiveRecordTemplate - - Alibaba Cloud Documentation Center

Updates the information about a live stream recording template.

Operation description

Only user-created templates can be updated. The preset template cannot be updated.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RecordFormat	array<object>	Yes	The list of recording formats.
	object	No	The recording format.
Format	string	Yes	The format of recording files. Note If you set this parameter to m3u8, you must also specify the SliceOssObjectPrefix and SliceDuration parameters.	m3u8
SliceDuration	integer	No	The duration of a single segment. Unit: seconds Note This parameter takes effect only if you set Format to m3u8. If you do not specify this parameter, the default value 30 seconds is used. Valid values: 5 to 30.	30
OssObjectPrefix	string	No	The name of the recording that is stored in Object Storage Service (OSS). The name must be less than 256 bytes in length and can contain the {JobId}, {Sequence}, {StartTime}, {EndTime}, {EscapedStartTime}, and {EscapedEndTime} variables. The name must contain the {StartTime} and {EndTime} variables or the {EscapedStartTime} and {EscapedEndTime} variables.	record/{JobId}/{Sequence}_{EscapedStartTime}_{EscapedEndTime}
SliceOssObjectPrefix	string	No	The name of the TS segment. Note This parameter is required only if you set Format to m3u8. By default, the duration of a segment is 30 seconds. The segment name must be less than 256 bytes in length and can contain the {JobId}, {UnixTimestamp}, and {Sequence} variables. The segment name must contain the {UnixTimestamp} and {Sequence} variables.	record/{JobId}/{UnixTimestamp}_{Sequence}
CycleDuration	integer	No	The duration of the recording cycle. Unit: seconds If you do not specify this parameter, the default value 6 hours is used. Note If a live stream is interrupted during a recording cycle but is resumed within 3 minutes, the stream is recorded in the same recording before and after the interruption. If a live stream is interrupted for more than 3 minutes, a new recording is generated. To change the default stream interruption time, submit a ticket.	3600
TemplateId	string	Yes	The template ID.	69e1f9fe-1e97-11ed-ba64-0c42a1b73d66
Name	string	Yes	The template name.	test template

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3

Examples

Success response

JSON format

{
  "RequestId": "0F3D5C03-4B6E-5F40-B7F6-B1956776E7D3"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.