AddVodTemplate - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Creates a snapshot template.

Operation Description

Note

After you create a snapshot template, you can specify the ID of the snapshot template in the request of the SubmitSnapshotJob operation to take snapshots.

You can receive the SnapshotComplete event notification by using an HTTP or HTTPS URL or in Message Service (MNS). For more information, see Overview.

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
vod:AddVodTemplate	Write	VOD acs:vod::{#accountId}:	none	none
vod:AddVodTemplate	Read	All Resources	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the template. The name can be up to 128 bytes in length. The value must be encoded in UTF-8.	test
TemplateType	string	Yes	The type of the template. Set the value to Snapshot.	Snapshot
TemplateConfig	string	Yes	The configurations of the snapshot template. The value is a JSON-formatted string. For more information about the data structure, see the "SnapshotTemplateConfig" section of the Media processing parameters topic.	{"SnapshotConfig":{"Count":10,"SpecifiedOffsetTime":0,"Interval":1},"SnapshotType":"NormalSnapshot"}
AppId	string	No	The ID of the application. Default value: app-1000000. For more information, see Overview.	app-****

Response parameters

Parameter	Type	Description	Example
	object
VodTemplateId	string	The ID of the snapshot template. You can call the SubmitSnapshotJob operation to take snapshots.	f5b228fe6930e*****0d6bf55bd87789
RequestId	string	The ID of the request.	25818875-5F78-4A*****F6-D7393642CA58

Examples

Sample success responses

JSONformat

{
  "VodTemplateId": "f5b228fe6930e*****0d6bf55bd87789",
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58"
}

Error codes

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