Use AddVodTemplate to add a snapshot template - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

After adding a template, you can pass the snapshot or animated image template ID through the SubmitSnapshotJob or SubmitDynamicImageJob operation to initiate a snapshot or animated image job.
You can receive video snapshot completed and video animated image completed callback messages through HTTP callbacks (compatible with HTTPS) or MNS callbacks. For more information, see Callback methods.

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

vod:AddVodTemplate

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The template name. The name can be up to 128 bytes in length. UTF-8 encoded.	test
TemplateType	string	Yes	The templatetype. Valid values: Snapshot: snapshot. DynamicImage: animated image.	Snapshot
TemplateConfig	string	Yes	The template configuration data in JSON format. For more information about the data structure, see Snapshot template configuration or Animated image template configuration.	{"SnapshotConfig":{"Count":10,"SpecifiedOffsetTime":0,"Interval":1,"FrameType":"normal"},"SnapshotType":"NormalSnapshot"}
AppId	string	No	The application ID. Default value: app-1000000. For more information, see Multi-application.	app-****

Response elements

Element	Type	Description	Example
	object
VodTemplateId	string	The snapshot or animated image template ID. This ID can be used as a request parameter of the SubmitSnapshotJob or SubmitDynamicImageJob operation to initiate snapshot or animated image processing.	f5b228fe6930e*****0d6bf55bd87789
RequestId	string	The request ID.	25818875-5F78-4A*****F6-D7393642CA58

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.