All Products
Search
Document Center

ApsaraVideo VOD:GetTranscodeTemplateGroup

Last Updated:May 11, 2024

Queries the details of a transcoding template group based on the template group ID.

Operation description

This operation returns information about the specified transcoding template group and the configurations of all the transcoding templates in the group.

Debugging

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

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:GetTranscodeTemplateGroupRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TranscodeTemplateGroupIdstringYes

The ID of the transcoding template group.

a591f697c7167*****6ae1502142d0

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

6730AC93-7B12-4B*****7F-49EE1FE8BC49
TranscodeTemplateGroupobject

The information about the transcoding template group.

CreationTimestring

The time when the transcoding template group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2018-12-12T10:20:51Z
IsDefaultstring

Indicates whether the template group is the default one. Valid values:

  • Default
  • NotDefault
NotDefault
AppIdstring

The ID of the application.

app-****
TranscodeTemplateGroupIdstring

The ID of the transcoding template group.

a59b11f697c716*****6ae1502142d0
Namestring

The name of the transcoding template group.

test
ModifyTimestring

The time when the transcoding template group was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2018-12-12T11:20:51Z
Lockedstring

Indicates whether the transcoding template group is locked. Valid values:

  • Disabled: The template group is not locked.
  • Enabled: The template group is locked.
Enabled
TranscodeTemplateListobject []

The information about the transcoding templates.

Typestring

The type of the transcoding template. Valid values:

  • Normal (default): a common transcoding template. The PackageSetting parameter cannot be set for this type of template.
  • VideoPackage: a video stream package template. If this type of template is used, ApsaraVideo VOD transcodes a video into video streams in different bitrates and packages these video streams with a file. The PackageSetting parameter must be set for this type of template.
  • SubtitlePackage: a subtitle package template. If this type of template is used, ApsaraVideo VOD adds the subtitle information to the output file generated by packaging the multi-bitrate video streams of the corresponding video without transcoding. You must set the PackageSetting parameter for a subtitle package template and associate the subtitle package template with a video stream package template. A template group can contain only one subtitle package template.
Normal
Videostring

The transcoding configurations of the video stream. The value is a JSON string.

{"Codec":"H.264","Bitrate":"900","Width":"960","Remove":"false","Fps":"30"}
TransConfigstring

The conditional transcoding configurations. This parameter can be used if you want to determine the basic logic based on the bitrate and resolution of the source file before the video is transcoded. The value is a JSON-formatted string.

{"IsCheckReso":"true","IsCheckResoFail":"false","IsCheckVideoBitrate":"false","IsCheckVideoBitrateFail":"false","IsCheckAudioBitrate":"false","IsCheckAudioBitrateFail":"false"}
Rotatestring

The video rotation identifier. It is used to control the image rotation angle. For example, if you set this parameter to 180, the video image is turned upside down. Valid values: [0,360].

90
TranscodeTemplateIdstring

The transcoding template ID.

696d29a11erc057*****a3acc398d02f4
TemplateNamestring

The name of the transcoding template.

test
EncryptSettingstring

The encryption configuration for transcoding.

"EncryptType":"Private"
Audiostring

The transcoding configurations of the audio stream. The value is a JSON string.

{\"Codec\":\"AAC\",\"Remove\":\"false\",\"Bitrate\":\"44\",\"Samplerate\":\"32000\",\"Channels\":\"2\",\"Profile\":\"aac_low\"}
TranscodeFileRegularstring

The custom path used to store the output files.

{MediaId}/transcoce_1
Containerstring

The format of the container used to encapsulate audio and video streams. The value is a JSON string.

"Format":"m3u8"
Clipstring

The clipping configurations of the video. The value is a JSON string. For example, this parameter is returned if you extract 5 seconds of content from a video to generate a new video.

{\"TimeSpan\":{\"Seek\":\"1\",\"Duration\":\"5\"}
Definitionstring

Valid values for the definition of a common transcoding template:

  • LD: low definition.
  • SD: standard definition.
  • HD: high definition.
  • FHD: ultra high definition.
  • OD: original quality.
  • 2K
  • 4K
  • SQ: standard sound quality.
  • HQ: high sound quality.

Valid values for the definition of a Narrowband HD™ 1.0 transcoding template:

  • LD-NBV1: low definition.
  • SD-NBV1: standard definition.
  • HD-NBV1: high definition.
  • FHD-NBV1: ultra high definition.
  • 2K-NBV1
  • 4K-NBV1
Note
  • You cannot change the definition of a transcoding template.
  • You cannot modify the system parameters, such as the video resolution, audio resolution, and bitrate, of Narrowband HD™ 1.0 transcoding templates.
  • You can create only Narrowband HD™ 1.0 transcoding templates that support the FLV, M3U8 (HLS), and MP4 output formats.
  • SD
    PackageSettingstring

    The packaging configuration. Only HLS packaging and DASH packaging are supported. The value is a JSON string.

    "PackageType":"HLSPackage","PackageConfig":{ "BandWidth":"900000" }
    SubtitleListstring

    The subtitle configurations. The value is a JSON string.

    [{"SubtitleUrl":"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass","CharEncode":"utf-8"}]
    MuxConfigstring

    The transcoding segment configurations. This parameter must be returned if HTTP-Live-Streaming (HLS) encryption is used. The value is a JSON string.

    "Segment": { "Duration":"6" }
    WatermarkIdsarray

    The IDs of the associated watermarks.

    string

    The ID of the associated watermark.

    "USER_DEFAULT_WATERMARK","ddddddddd"
    TraceMarkstring

    The content of the tracing watermark.

    { "Enable": true }
    CopyrightMarkstring

    The content of the copyright watermark.

    { "Content": "test" }

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "6730AC93-7B12-4B*****7F-49EE1FE8BC49",
      "TranscodeTemplateGroup": {
        "CreationTime": "2018-12-12T10:20:51Z",
        "IsDefault": "NotDefault",
        "AppId": "app-****",
        "TranscodeTemplateGroupId": "a59b11f697c716*****6ae1502142d0",
        "Name": "test",
        "ModifyTime": "2018-12-12T11:20:51Z",
        "Locked": "Enabled",
        "TranscodeTemplateList": [
          {
            "Type": "Normal",
            "Video": "{\"Codec\":\"H.264\",\"Bitrate\":\"900\",\"Width\":\"960\",\"Remove\":\"false\",\"Fps\":\"30\"}",
            "TransConfig": "{\"IsCheckReso\":\"true\",\"IsCheckResoFail\":\"false\",\"IsCheckVideoBitrate\":\"false\",\"IsCheckVideoBitrateFail\":\"false\",\"IsCheckAudioBitrate\":\"false\",\"IsCheckAudioBitrateFail\":\"false\"}",
            "Rotate": "90",
            "TranscodeTemplateId": "696d29a11erc057*****a3acc398d02f4",
            "TemplateName": "test",
            "EncryptSetting": "\"EncryptType\":\"Private\"",
            "Audio": "{\\\"Codec\\\":\\\"AAC\\\",\\\"Remove\\\":\\\"false\\\",\\\"Bitrate\\\":\\\"44\\\",\\\"Samplerate\\\":\\\"32000\\\",\\\"Channels\\\":\\\"2\\\",\\\"Profile\\\":\\\"aac_low\\\"}",
            "TranscodeFileRegular": "{MediaId}/transcoce_1",
            "Container": "\"Format\":\"m3u8\"",
            "Clip": "{\\\"TimeSpan\\\":{\\\"Seek\\\":\\\"1\\\",\\\"Duration\\\":\\\"5\\\"}",
            "Definition": "SD",
            "PackageSetting": "\"PackageType\":\"HLSPackage\",\"PackageConfig\":{   \"BandWidth\":\"900000\"  }",
            "SubtitleList": "[{\"SubtitleUrl\":\"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass\",\"CharEncode\":\"utf-8\"}]",
            "MuxConfig": "\"Segment\": { \"Duration\":\"6\" }",
            "WatermarkIds": [
              "\"USER_DEFAULT_WATERMARK\",\"ddddddddd\""
            ],
            "TraceMark": "{\n\t\"Enable\": true\n}",
            "CopyrightMark": "{\n\t\"Content\": \"test\"\n}"
          }
        ]
      }
    }

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-09-14The response structure of the API has changedsee changesets
    Change itemChange content
    Output ParametersThe response structure of the API has changed.

    Common errors

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

    Error codeError messageHTTP status codeDescription
    InvalidTranscodeTemplateGroup.NotFoundThe transcode template group does not exist.404The error message returned because the specified transcoding template group does not exist.