Use GetTranscodeTemplateGroup to query transcoding template group details - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the details of a transcoding configuration by transcoding template group ID.

Operation description

Retrieves information about a single template group, including the configuration information of all transcoding templates in the group.

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:GetTranscodeTemplateGroup

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TranscodeTemplateGroupId	string	Yes	The transcoding template group ID.	a591f697c7167*****6ae1502142d0

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6730AC93-7B12-4B*****7F-49EE1FE8BC49
TranscodeTemplateGroup	object	The transcoding template group data.
CreationTime	string	The time when the template group was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2018-12-12T10:20:51Z
IsDefault	string	Indicates whether the template group is the default one. Valid values: Default: The template group is the default one. NotDefault: The template group is not the default one.	NotDefault
AppId	string	The application ID.	app-****
TranscodeTemplateGroupId	string	The transcoding template group ID.	a59b11f697c716*****6ae1502142d0
Name	string	The name of the template group.	test
ModifyTime	string	The time when the template group was last modified. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2018-12-12T11:20:51Z
Locked	string	Indicates whether the template group is locked. Valid values: Disabled: Not locked. Enabled: Locked.	Enabled
TranscodeTemplateList	array<object>	The list of transcoding template configurations.
	object
Type	string	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
Video	string	The transcoding configurations of the video stream. The value is a JSON string.	{"Codec":"H.264","Bitrate":"900","Width":"960","Remove":"false","Fps":"30"}
TransConfig	string	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"}
Rotate	string	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
TranscodeTemplateId	string	The transcoding template ID.	696d29a11erc057*****a3acc398d02f4
TemplateName	string	The name of the transcoding template.	test
EncryptSetting	string	The encryption configuration for transcoding.	"EncryptType":"Private"
Audio	string	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"}
TranscodeFileRegular	string	The custom path used to store the output files.	{MediaId}/transcoce_1
Container	string	The format of the container used to encapsulate audio and video streams. The value is a JSON string.	"Format":"m3u8"
Clip	string	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"}
Definition	string	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
PackageSetting	string	The packaging configuration. Only HLS packaging and DASH packaging are supported. The value is a JSON string.	"PackageType":"HLSPackage","PackageConfig":{ "BandWidth":"900000" }
SubtitleList	string	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"}]
MuxConfig	string	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" }
WatermarkIds	array	The IDs of the associated watermarks.
	string	The ID of the associated watermark.	"USER_DEFAULT_WATERMARK","ddddddddd"
TraceMark	string	The content of the tracing watermark.	{ "Enable": true }
CopyrightMark	string	The content of the copyright watermark.	{ "Content": "Test copyright watermark text" }

Examples

Success response

JSON format

{
  "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\"Content\": \"Test copyright watermark text\"\n}"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.