UpdateLiveSnapshotTemplate - Intelligent Media Services - Alibaba Cloud Documentation Center

Updates the information about a live stream snapshot template.

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:UpdateLiveSnapshotTemplate		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The template ID.	**a046-263c-3560-978a-fb287782**
TemplateName	string	Yes	The name of the template. It cannot exceed 128 characters in length.
OverwriteFormat	string	No	The naming format of the snapshot captured in overwrite mode. The value cannot start with a forward slash (/). Only the suffix .jpg is supported. The value cannot exceed 255 characters in length. The {JobId} placeholder is supported. It specifies the ID of the snapshot job. Placeholders such as {UnixTimestamp}, {Sequence}, and {Date} are not allowed. You must specify at least one of the OverwriteFormat and SequenceFormat parameters.	snapshot/{JobId}.jpg
SequenceFormat	string	No	The naming format of the snapshot captured in time series mode. The value cannot start with a forward slash (/). Only the suffix .jpg is supported. The value cannot exceed 255 characters in length. The {JobId}, {Date}, {UnixTimestamp}, and {Sequence} placeholders are supported. {JobId} specifies the ID of the snapshot job. {Date} specifies the date on which the snapshot is captured. {UnixTimestamp} specifies the timestamp of the snapshot. {Sequence} specifies the sequence number of the snapshot. You must specify at least one of the {UnixTimestamp} and {Sequence} placeholders. You must specify at least one of the OverwriteFormat and SequenceFormat parameters.	snapshot/{JobId}/{UnixTimestamp}.jpg
TimeInterval	integer	Yes	The interval between two adjacent snapshots. Unit: seconds. Valid values: [5,3600].	5

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	%s
400	InvalidParameter	%s
403	UserDisable	User is disable.
403	Forbidden	User not authorized to operate on the specified resource.
403	OperationDenied	Your account has not enabled the ICE service.
404	TemplateNotFound	No such template.
500	InternalError	The request processing has failed due to some unknown error.

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