Help Center/ Video On Demand/ API Reference/ Transcoding Template Group Management/ Querying Transcoding Template Groups

Updated on 2025-11-26 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Transcoding Template Groups

Function

This API is used to query transcoding template groups.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1.0/{project_id}/asset/template-collection/transcodings

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
group_collection_id	No	String	Template group ID.
offset	No	Integer	Offset. The default value is 0. This parameter is invalid when group_collection_id is specified.
limit	No	Integer	Number of records on each page. The value defaults to 10 and ranges from 1 to 100. This parameter is invalid when group_collection_id is specified.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when a request is sent. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
template_group_collection_list	Array of TemplateGroupCollection objects	Template group information.
total	Integer	Total number of records.

**Table 5** TemplateGroupCollection
Parameter	Type	Description
group_collection_id	String	Template group ID.
name	String	Template group name.
description	String	Template description.
template_group_list	Array of TemplateGroup objects	Transcoding template group list.

**Table 6** TemplateGroup
Parameter	Type	Description
group_id	String	Template group ID.
name	String	Template group name.
status	String	Whether it is set as the default one. 0: It is not set as the default one. 1: It is set as the default one.
type	String	Template group type. system_template_group: system template group custom_template_group: custom template group non_transcoding_template_group: non-transcoding system template group adaptive_template_group: adaptive system template group
auto_encrypt	Integer	Whether to automatically encrypt a file. The options include: 0: not encrypted 1: encrypted Default value: 0 Encryption and transcoding must be performed at the same time. If encryption is required, the transcoding parameters cannot be empty, and the transcoding output format must be HLS.
quality_info_list	Array of QualityInfo objects	Image quality configuration.
watermark_template_ids	Array of strings	Array of IDs for the associated watermark templates
description	String	Template description.
common	Common object	Parameters shared by the low-bitrate HD transcoding switch, low-bitrate HD transcoding version, and multi-stream encoding format.

**Table 7** QualityInfo
Parameter	Type	Description
video	VideoTemplateInfo object	Video template information.
audio	AudioTemplateInfo object	Audio template information.
format	String	Format.

**Table 8** VideoTemplateInfo
Parameter	Type	Description
quality	String	Video quality.
width	Integer	Video width.
height	Integer	Video height.
bitrate	Integer	Bitrate.
frame_rate	Integer	Frame rate (in FPS), which defaults to 1 indicating adaptive frame rate.

**Table 9** AudioTemplateInfo
Parameter	Type	Description
sample_rate	Integer	Audio sampling rate. Possible values are: 1: AUDIO_SAMPLE_AUTO 2: AUDIO_SAMPLE_22050 3: AUDIO_SAMPLE_32000 4: AUDIO_SAMPLE_44100 5: AUDIO_SAMPLE_48000 6: AUDIO_SAMPLE_96000 Default value: 1
bitrate	Integer	Audio bitrate, in kbit/s.
channels	Integer	Number of audio channels. The options include: 1: AUDIO_CHANNELS_1 2: AUDIO_CHANNELS_2

**Table 10** Common
Parameter	Type	Description
pvc	String	Low-bitrate HD transcoding switch.
pvc_version	String	Low-bitrate HD transcoding version.
video_codec	String	Video codec.
audio_codec	String	Audio codec. Possible values are: 1: AUDIO_CODECTYPE_AAC 2: AUDIO_CODECTYPE_HEAAC1 3: AUDIO_CODECTYPE_HEAAC2 4: AUDIO_CODECTYPE_MP3 Default value: 1
hls_interval	Integer	Segment file duration, which defaults to 5 seconds.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

This example queries transcoding template groups.

GET https://{endpoint}/v1.0/{project_id}/asset/template-collection/transcodings

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "template_group_collection_list" : [ {
    "group_collection_id" : "9751249d25f14587b212544d6fd8dcf8",
    "name" : "test",
    "template_group_list" : [ {
      "group_id" : "9751249d25f14587b212544d6fd8dcf8",
      "name" : "test112",
      "status" : "0",
      "type" : "custom_template_group",
      "auto_encrypt" : 0,
      "quality_info_list" : [ {
        "video" : {
          "quality" : "UNKNOW",
          "width" : 0,
          "height" : 0,
          "bitrate" : 0,
          "frame_rate" : 0
        },
        "audio" : null,
        "format" : "UNKNOW"
      } ],
      "watermark_template_ids" : null,
      "description" : null,
      "common" : {
        "pvc" : null,
        "pvc_version" : null,
        "video_codec" : null,
        "audio_codec" : "AAC",
        "hls_interval" : 0
      }
    } ]
  } ],
  "total" : 1
}

Status code: 400

Returned when the request failed.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code	Description
200	Returned when the request succeeded.
400	Returned when the request failed.

Error Codes

See Error Codes.

Parent topic: Transcoding Template Group Management

Previous topic: Modifying a Transcoding Template Group

Next topic: Deletes a Transcoding Template Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot