All Products
Search
Document Center

ApsaraVideo VOD:AddTranscodeTemplateGroup

Last Updated:Dec 14, 2022

Creates a transcoding template group or adds one or more transcoding templates to a template group.

Operation Description

  • You cannot perform custom operations on transcoding template groups that are locked in the ApsaraVideo VOD console. To manage these transcoding template groups, submit a ticket to contact Alibaba Cloud technical support.
  • An Object Storage Service (OSS) bucket is required to store files that are used for transcoding. You can create a transcoding template group only after ApsaraVideo VOD has allocated a bucket to you. You can activate the bucket on the Storage page in the ApsaraVideo VOD console.
  • You cannot add transcoding templates to the No Transcoding template group.
  • You can create a maximum of 20 transcoding template groups.
  • You can add a maximum of 20 transcoding templates to a transcoding template group.
  • If you need to generate an URL for adaptive bitrate streaming, you can add a maximum of 10 video packaging templates to a transcoding template group. If you add more than 10 video packaging templates, URLs of the video transcoded based on the video packaging templates are generated but the URL for adaptive bitrate streaming is not generated.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
vod:AddTranscodeTemplateGroupWrite
  • VOD
    acs:vod:*:{#accountId}:*/*
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringNo

The name of the transcoding template group.

  • The name can be up to 128 bytes in length.
  • The value must be encoded in UTF-8.
NoteYou must set TranscodeTemplateGroupId or Name in the request.
transcodetemplate
TranscodeTemplateListstringNo

The configurations of the transcoding template. The value is a string in JSON format. For more information about the data structure, see Basic structures.

NoteIf you do not specify this parameter, the transcoding job cannot be automatically created after you upload a video.
[{"Video":{"Bitrate":"400","Codec":"H.264","Fps":"30","Height":""},"Definition":"SD","Container":{"Format":"mp4"},"TemplateName":"testName","MuxConfig":{},"Audio":{"Codec":"AAC","Bitrate":"64","Samplerate":"44100"}}]
TranscodeTemplateGroupIdstringNo

The ID of the transcoding template group. If a transcoding template group ID is specified, you can add new transcoding templates to the template group.

NoteYou must set TranscodeTemplateGroupId or Name in the request.
4c71a339fe52b4fa6f4527****
AppIdstringNo

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

app-****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

TranscodeTemplateGroupIdstring

The ID of the transcoding template group.

34e908aa4024af7821c31f93a2a****
RequestIdstring

The ID of the request.

25818875-5F78-4AF6-D7393642CA58****

Example

Normal return example

JSONFormat

{
  "TranscodeTemplateGroupId": "34e908aa4024af7821c31f93a2a****",
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

Error codes

For a list of error codes, visit the API error center.

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
InvalidStorage.NotFoundThe storage info dose not exist.404The error message returned because the storage path is not specified.
InvalidTranscodeTemplateGroup.NotFoundThe transcode template group does not exist.404The error message returned because the specified transcoding template group does not exist.
Forbidden.LockedTemplateGroupThe transcode template group has been locked.403The error message returned because the specified template group is locked and cannot be managed. To manage the template group, contact the ApsaraVideo VOD technical support.
Forbidden.SpecialTemplateGroupThe transcode template group is using for special purpose.403The error message returned because the specified transcoding template group is used for a special purpose and you cannot add transcoding templates to the group. For example, the No Transcoding and Storage Only template groups are used for special purposes.
TrasncodeTemplateGroupExceededMaxThe transcode template group size exceeded maximum.400The error message returned because the number of transcoding template groups exceeds the upper limit. You can create a maximum of 20 transcoding template groups.
TranscodeTemplateExceededMaxThe template transcode template config size exceeded maximum.400The error message returned because the number of transcoding templates that are added to the specified transcoding template group exceeds the upper limit. You can add a maximum of 20 transcoding templates to a transcoding template group.
WatermarkExceededMaxThe watermark size exceeded maximum.400The error message returned because the number of watermark IDs that are associated with a transcoding template in the transcoding template group exceeds the upper limit. You can associate a maximum of four watermark IDs with a transcoding template.