Querying Transcoding Templates
Function
Queries one or more custom transcoding templates.
You can query up to 10 templates by ID or page number.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
mpc:transcodeTemplate:view
List
-
-
-
-
URI
GET /v1/{project_id}/template/transcodings
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
template_id |
No |
Array of integers |
ID of a transcoding template. A maximum of 10 transcoding template IDs can be queried at a time. |
|
page |
No |
Integer |
Page number. This parameter is invalid when task_id is specified. Default value: 0 |
|
size |
No |
Integer |
Number of records on each page. Value range: [1,1000]. This parameter is invalid when template_id is specified. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token The token 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 when AK/SK-based authentication is used. |
|
X-Project_Id |
No |
String |
Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters. |
|
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
template_array |
Array of TemplateInfo objects |
Details about the transcoding templates |
|
total |
Integer |
Total number of transcoding templates |
|
Parameter |
Type |
Description |
|---|---|---|
|
template_id |
Integer |
ID of each queried transcoding template |
|
template |
QueryTransTemplate object |
Configurations built in the transcoding templates |
|
Parameter |
Type |
Description |
|---|---|---|
|
template_name |
String |
Name of a transcoding template |
|
video |
Video object |
Video information |
|
audio |
Audio object |
Audio information |
|
common |
Common object |
Common information |
|
Parameter |
Type |
Description |
|---|---|---|
|
PVC |
Boolean |
Whether to enable low-bitrate HD The options are as follows: (The value 0 indicates that the function is disabled. Other positive integers and negative values indicate true.) |
|
hls_interval |
Integer |
HLS segment duration. This parameter is used only when pack_type is set to 1 or 3. Value range: [2,10] Unit: second |
|
dash_interval |
Integer |
DASH segment duration. This parameter is used only when pack_type is set to 2 or 3. Value range: [2,10] Unit: second |
|
pack_type |
Integer |
Container format. The options include:
NOTE:
If pack_type is set to 5 or 6, do not configure video parameters. If pack_type is set to 9, multi-audio is not supported. If pack_type is set to 10, H.265 encoding is not supported. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error description |
Example Requests
GET https://{endpoint}/v1/{project_id}/templates/transcoding?template_id=80985
Example Responses
Status code: 200
Transcoding template queried successfully.
{
"template_array" : [ {
"template_id" : 80985,
"template" : {
"template_name" : "test_template",
"video" : {
"output_policy" : "transcode",
"codec" : 1,
"bitrate" : 0,
"profile" : 3,
"level" : 15,
"preset" : 3,
"max_iframes_interval" : 5,
"bframes_count" : 4,
"frame_rate" : 0,
"width" : 0,
"height" : 0,
"black_cut" : 0
},
"audio" : {
"output_policy" : "transcode",
"codec" : 1,
"bitrate" : 0,
"sample_rate" : 1,
"channels" : 2
},
"common" : {
"PVC" : false,
"hls_interval" : 5,
"dash_interval" : 5,
"pack_type" : 1
}
}
} ],
"total" : 1
}
Status code: 403
Failed to query the transcoding template.
{
"error_code" : "MPC.10212",
"error_msg" : "Operation failed."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Transcoding template queried successfully. |
|
403 |
Failed to query the transcoding template. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
