GetTranscodeTemplateGroup - ApsaraVideo VOD - Alibaba Cloud Documentation Center

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

Operation description

Note This operation returns the 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:GetTranscodeTemplateGroup	Read	All Resources *	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	6730AC93-7B12-4B*****7F-49EE1FE8BC49
TranscodeTemplateGroup	object	The information about the transcoding template group.
CreationTime	string	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
IsDefault	string	Indicates whether the template group is the default one. Valid values: Default NotDefault	NotDefault
AppId	string	The ID of the application.	app-****
TranscodeTemplateGroupId	string	The ID of the transcoding template group.	a59b11f697c716*****6ae1502142d0
Name	string	The name of the transcoding template group.	test
ModifyTime	string	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
Locked	string	Indicates whether the template group is locked. Valid values: Disabled: The template group is not locked. Enabled: The template group is locked.	Enabled
TranscodeTemplateList	object []	The information about the transcoding templates.
Type	string	The type of the transcoding template. Valid values: Normal (default): a common transcoding template. You cannot set the PackageSetting parameter 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 creates a multi-bitrate video package. You must set the PackageSetting parameter 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 that is generated by packaging the multi-bitrate video streams of the corresponding video. You must set the PackageSetting parameter for a subtitle packaging template and associate the subtitle packaging template with a video stream packaging template. You can configure only one subtitle packaging template in a template group.	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 is used if you want to determine the basic logic based on the bitrate and resolution of the source file before the transcoded video is generated. The value is a JSON string.	{"IsCheckReso":"true","IsCheckResoFail":"false","IsCheckVideoBitrate":"false","IsCheckVideoBitrateFail":"false","IsCheckAudioBitrate":"false","IsCheckAudioBitrateFail":"false"}
Rotate	string	The video rotation identifier. This parameter 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 ID of the transcoding template.	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 that is used to encapsulate audio and video streams. The value is a JSON string.	"Format":"m3u8"
Clip	string	The video cropping configurations. The value is a JSON string. For example, you can set this parameter to 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 of Narrowband HD™ 1.0 transcoding templates such as the video resolution, audio resolution, and bitrate. 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 HTTP-Live-Streaming (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 is used when you transcode a media stream into an HLS file. The value is a JSON string.	"Segment": { "Duration":"6" }
WatermarkIds	array	The IDs of associated watermarks.
	string	The ID of the associated watermark.	"USER_DEFAULT_WATERMARK","ddddddddd"
TraceMark	string	TraceMark.	{ "Enable": true }
CopyrightMark	string	CopyrightMark.	{ "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 time

Summary of changes

Operation

2023-09-14

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

Common errors

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

Error code	Error message	HTTP status code	Description
InvalidTranscodeTemplateGroup.NotFound	The transcode template group does not exist.	404	The error message returned because the specified transcoding template group does not exist.