All Products
Search

This Product

    ApsaraVideo VOD:AddVodTemplate

    Document Center

    ApsaraVideo VOD:AddVodTemplate

    Last Updated:Dec 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

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    vod:AddVodTemplatecreate
    *All Resources
    *
      none
    		none

    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.