All Products
Search
Document Center

ApsaraVideo VOD:AddVodTemplate

Last Updated:Jul 19, 2024

Adds a snapshot template or frame animation template.

Operation description

  • After you add a snapshot template, you can call the SubmitSnapshotJob operation and specify the template ID to submit a snapshot job.

  • You can use the HTTP (HTTPS compatible) callback or MNS callback method to receive the SnapshotComplete callback. For more information, see Overview .

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

The name of the template.

  • The name cannot exceed 128 bytes.
  • The value must be encoded in UTF-8.
test
TemplateTypestringYes

The type of the template. Set the value to Snapshot.

Snapshot
TemplateConfigstringYes

The configurations of the snapshot template. The value must be a JSON string. For more information about the data structure, see SnapshotTemplateConfig and DynamicImageTemplateConfig .

{"SnapshotConfig":{"Count":10,"SpecifiedOffsetTime":0,"Interval":1,"FrameType":"normal"},"SnapshotType":"NormalSnapshot"}
AppIdstringNo

The ID of the application. Default value: app-1000000. For more information, see Multi-application service.

app-****

Response parameters

ParameterTypeDescriptionExample
object
VodTemplateIdstring

The ID of the snapshot template. You can call the SubmitSnapshotJob operation to submit snapshot jobs.

f5b228fe6930e*****0d6bf55bd87789
RequestIdstring

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.