Help Center/ Video On Demand/ API Reference/ Transcoding Template Group Management/ Creates a Transcoding Template Group
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creates a Transcoding Template Group

Function

This API is used to create a transcoding template group.

Constraints

  • If the output types defined in different templates are the same, the templates cannot be added to the same transcoding template group.

  • If the encoding formats of the templates are the same, the output types HLS/DASH (either) and HLS_DASH cannot coexist in the same transcoding template group. This constraint does not apply to templates with different encoding formats.

codec indicates the video encoding format, which can be H.264 or H.265. For details, see Querying Media Assets.

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

POST /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.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Template group name.

description

No

String

Template group description.

template_group_list

Yes

Array of strings

Template group list. Template IDs.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

group_collection_id

String

Template group ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example creates a transcoding template group.

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

Content-Type: application/json
{
  "name": "test",
  "template_group_list": [
    "780640dd1d584a6999b104568c358b78",
    "6a16d8d0161c42caa42b9c148d032871"
  ]
}

Example Responses

Status code: 201

Returned when the request succeeded.

{
  "group_collection_id" : "f9b045e0811c482f9de0d436a5927bb6"
}

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

201

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.