Help Center/ Media Processing Center/ API Reference/ Transcoding APIs/ Querying Transcoding Tasks

Updated on 2024-01-18 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Transcoding Tasks

Function

This API is used to query one or more transcoding tasks.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/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
task_id	No	Array	Task ID. A maximum of 10 transcoding task IDs can be queried at a time.
status	No	String	Task execution status Possible options are: WAITING: pending TRANSCODING: executing SUCCEEDED: completed FAILED: failed CANCELED: deleted NEED_TO_BE_AUDIT: pending for review
start_time	No	String	Start time. If task_id is specified, this parameter is invalid. Its format is yyyymmddhhmmss. The value must be a time-zone agnostic UTC time.
end_time	No	String	End time. If task_id is specified, this parameter is invalid. Its format is yyyymmddhhmmss. The value must be a time-zone agnostic UTC time.
page	No	Integer	Page number. If task_id is specified, this parameter is invalid. Default value: 0
size	No	Integer	Number of records on each page. If task_id is specified, this parameter is invalid. The value ranges from 1 to 100. Default value: 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-language	No	String	Client language.
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

**Table 4** Response body parameters
Parameter	Type	Description
task_array	Array of QueryTranscodingsTaskResponse objects	List of transcoding tasks
is_truncated	Integer	Whether the query results are truncated. Possible values: 1: Query results are truncated. Some results are not returned. You can configure the page and size parameters to continue the query. 0: Query results are not truncated. All results are returned.
total	Integer	Number of records

**Table 5** QueryTranscodingsTaskResponse
Parameter	Type	Description
task_id	String	Task ID
status	String	Task status
progress	Integer	Task execution progress, in percentage. The value ranges from 0 to 100. This function is available only to whitelisted users. To get whitelisted, contact technical support.
create_time	String	Task start time
end_time	String	Task end time
trans_template_id	Array of integers	ID of transcoding templates
input	ObsObjInfo object	Storage location of an input file. The information includes the location, bucket name, and path.
output	ObsObjInfo object	Storage location of an output file. The information includes the location, bucket name, and path.
output_file_name	Array of strings	Name of the output file. The value is of the array type and may contain multiple names, including snapshot names.
user_data	String	Custom user data
error_code	String	Status code of a transcoding task
description	String	Task description. If an error occurs in a transcoding task, this field indicates the error cause.
tips	String	Message displayed if the audio sampling rate is too low
transcode_detail	TranscodeDetail object	Output information of snapshots
thumbnail_output	ObsObjInfo object	Output information of snapshots. The information includes the location, bucket name, and path.
thumbnail_outputname	String	Name of the snapshot package
pic_info	Array of PicInfo objects	Snapshot file information
av_parameters	Array of AvParameters objects	Transcoding parameter If both trans_template_id and this parameter are configured, this parameter is preferentially used for transcoding.

**Table 6** TranscodeDetail
Parameter	Type	Description
multitask_info	Array of MultiTaskInfo objects	Details about failed transcoding in the case of one-in and multiple-out
input_file	SourceInfo object	Input file information

**Table 7** MultiTaskInfo
Parameter	Type	Description
template_id	Integer	Template ID
error	ErrorResponse object	Error message about failed transcoding
output_file	SourceInfo object	Information about a single output

**Table 8** ErrorResponse
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

**Table 9** SourceInfo
Parameter	Type	Description
duration	Integer	Duration of an input file Unit: second
duration_ms	Long	Duration of an input file Unit: ms
format	String	File format
size	Long	Size of an input file
video_info	VideoInfo object	Video information
audio_info	Array of AudioInfo objects	Audio information

**Table 10** VideoInfo
Parameter	Type	Description
width	Integer	Video width
height	Integer	Video height
bitrate	Integer	Video bitrate Unit: kbit/s
bitrate_bps	Long	Video bitrate Unit: bit/s
frame_rate	Integer	Frame rate. The value is 0 or ranges from 5 to 60. The value 0 indicates adaptive frame rate. Unit: FPS NOTE: If the configured frame rate is not within the value range, the value is automatically changed to 0. If the configured frame rate is higher than the frame rate of the input file, the value is automatically changed to the frame rate of the input file.
codec	String	Video codec

**Table 11** AudioInfo
Parameter	Type	Description
codec	String	Audio codec
sample	Integer	Audio sampling rate
channels	Integer	Number of audio channels
bitrate	Integer	Audio bitrate Unit: kbit/s
bitrate_bps	Long	Audio bitrate Unit: bit/s

**Table 12** ObsObjInfo
Parameter	Type	Description
bucket	String	OBS bucket name
location	String	Region where an OBS bucket is located. It must be the same as the region where MPC is deployed.
object	String	OBS object path, which complies with the OSS Object definition. If this parameter is used for an input, an object must be specified. If this parameter is used for an output, only the directory for storing the output needs to be specified.
file_name	String	File name If this parameter is specified, the output object name is object/file_name. If this parameter is not specified, the output object name is object/xxx, where xxx is specified by MPC. When it is used as the output file name: Specifies the name of the output file. This parameter is valid for packaging. If the output file name needs to be specified during transcoding, use the output_filenames parameter. This parameter is valid for parsing. If a file name is specified during parsing, the parsing parameters are written to the specified file name and the file metadata is obtained through the query API response in JSON format. This parameter is invalid for snapshot capturing. This parameter is invalid for conversion into animated GIFs.

**Table 13** PicInfo
Parameter	Type	Description
pic_name	String	Snapshot file name

**Table 14** AvParameters
Parameter	Type	Description
video	VideoParameters object	Video parameters
audio	Audio object	Audio parameters
common	Common object	Common parameters

**Table 15** VideoParameters
Parameter	Type	Description
output_policy	String	Output policy: If output_policy is set to discard in video parameters and transcode in audio parameters, only audio is output. If output_policy is set to transcode in video parameters and to discard in audio parameters, only video is output. If output_policy is set to copy in video parameters, the original video is copied without codec. If output_policy is set to copy in audio parameters, the original audio is copied without codec. output_policy cannot be set to discard in video and audio parameters at the same time. If output_policy is set to transcode in video and video parameters at the same time, video and audio are output. The options are as follows: discard transcode copy
codec	Integer	Video codec. Possible values: 1: VIDEO_CODEC_H264 2: VIDEO_CODEC_H265
bitrate	Integer	Average output bitrate Its value is 0 or an integer ranging from 40 to 50,000. Unit: kbit/s If this parameter is set to 0, the average output bitrate is an adaptive value.
profile	Integer	Encoding profile. Possible values: 1: VIDEO_PROFILE_H264_BASE 2: VIDEO_PROFILE_H264_MAIN 3: VIDEO_PROFILE_H264_HIGH 4: VIDEO_PROFILE_H265_MAIN
level	Integer	Encoding level Options: 0: AUTO 1: VIDEO_LEVEL_1_0 2: VIDEO_LEVEL_1_1 3: VIDEO_LEVEL_1_2 4: VIDEO_LEVEL_1_3 5: VIDEO_LEVEL_2_0 6: VIDEO_LEVEL_2_1 7: VIDEO_LEVEL_2_2 8: VIDEO_LEVEL_3_0 9: VIDEO_LEVEL_3_1 10: VIDEO_LEVEL_3_2 11: VIDEO_LEVEL_4_0 12: VIDEO_LEVEL_4_1 13: VIDEO_LEVEL_4_2 14: VIDEO_LEVEL_5_0 15: VIDEO_LEVEL_5_1
preset	Integer	Encoding quality. Possible options: 1: VIDEO_PRESET_SPEED (fast encoding) 2: VIDEO_PRESET_NORMAL (common encoding), which is not recommended 3: VIDEO_PRESET_HIGHQUALITY (high-quality encoding) Default value: 1
max_iframes_interval	Integer	Maximum I-frame interval. The value ranges from 2 to 10. Default value: 5 Unit: second
bframes_count	Integer	Maximum B-frame interval The options are as follows: H264: The value ranges from 0 to 8 and defaults to 4. H.265: The value ranges from 0 to 8 and defaults to 7. Unit: frame
frame_rate	Integer	Frame rate. The value is 0 (adaptive) or ranges from 5 to 60. Unit: FPS NOTE: If the configured frame rate is not within the value range, the value is automatically changed to 0. If the configured frame rate is higher than the frame rate of the input file, the value is automatically changed to the frame rate of the input file.
width	Integer	Video width, in pixels H.264: The value is a multiple of 2 from 32 to 4,096. H.265: The value is a multiple of 2 from 320 to 4,096.
height	Integer	Video height, in pixels H.264: The value is a multiple of 2 from 32 to 2,880. H.265: The value is a multiple of 2 from 240 to 2,880.
black_cut	Integer	Whether to enable black bar removal. 0: disables black bar removal 1: enables black bar removal and low-complexity algorithms for videos longer than 5 minutes 2: enables black bar removal and high-complexity algorithms for videos no longer than 5 minutes

**Table 16** Audio
Parameter	Type	Description
output_policy	String	Output policy: If output_policy is set to discard in video parameters and transcode in audio parameters, only audio is output. If output_policy is set to transcode in video parameters and to discard in audio parameters, only video is output. If output_policy is set to copy in video parameters, the original video is copied without codec. If output_policy is set to copy in audio parameters, the original audio is copied without codec. output_policy cannot be set to discard in video and audio parameters at the same time. If output_policy is set to transcode in video and video parameters at the same time, video and audio are output. The options are as follows: discard transcode copy
codec	Integer	Audio codec Possible options are: 1: AAC 2: HEAAC1 3: HEAAC2 4: MP3
sample_rate	Integer	Audio sampling rate The options are as follows: 1: AUDIO_SAMPLE_AUTO 2: AUDIO_SAMPLE_22050 (22,050 Hz) 3: AUDIO_SAMPLE_32000 (32,000 Hz) 4: AUDIO_SAMPLE_44100 (44,100 Hz) 5: AUDIO_SAMPLE_48000 (48,000 Hz) 6: AUDIO_SAMPLE_96000 (96,000 Hz) NOTE: When the encoding format is MP3, the audio sampling ratio cannot be 6.
bitrate	Integer	Audio bitrate. The value is 0 or ranges from 8 to 1,000. Unit: kbit/s
channels	Integer	Number of audio channels Options: 1: AUDIO_CHANNELS_1 (mono) 2: AUDIO_CHANNELS_2 (stereo) 6: AUDIO_CHANNELS_5_1 (5.1 surround sound) When the media packaging format is audio (MP3), the number of audio channels cannot be set to 5.1.

**Table 17** Common
Parameter	Type	Description
PVC	Boolean	Whether to enable low-bitrate HD The options are as follows: false: disabled (This function is disabled by default.) true: enabled (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. The value ranges from 2 to 10. Unit: second
dash_interval	Integer	DASH segment duration. This parameter is used only when pack_type is set to 2 or 3. The value ranges from 2 to 10. Unit: second
pack_type	Integer	Packaging type Possible options are: 1: HLS 2: DASH 3: HLS+DASH 4: MP4 5: MP3 6: ADTS NOTE: If pack_type is set to 5 or 6, do not configure video parameters.

Status code: 400

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

Example Requests

GET https://{endpoint}/v1/{project_id}/transcodings?task_id=22123973

Example Responses

Status code: 200

Transcoding task queried successfully.

{
  "is_truncated" : 0,
  "total" : 1,
  "task_array" : [ {
    "task_id" : 22123973,
    "status" : "SUCCEEDED",
    "create_time" : 20200310031605,
    "end_time" : 20200310031623,
    "trans_template_id" : [ 4 ],
    "input" : {
      "bucket" : "example-bucket",
      "location" : "region01",
      "object" : "example-input.mp4"
    },
    "output" : {
      "bucket" : "example-bucket",
      "location" : "region01",
      "object" : "example-output.mp4"
    },
    "output_file_name" : [ "example_480X270.m3u8" ],
    "transcode_detail" : {
      "multitask_info" : [ {
        "template_id" : 4,
        "output_file" : {
          "duration" : 59,
          "duration_ms" : 0,
          "format" : "HLS",
          "size" : 2180,
          "video_info" : {
            "width" : 480,
            "height" : 270,
            "bitrate" : 231,
            "bitrate_bps" : 0,
            "frame_rate" : 25000,
            "codec" : "H264"
          },
          "audio_info" : [ {
            "codec" : "HEAAC",
            "sample" : 44100,
            "channels" : 2,
            "bitrate" : 64,
            "bitrate_bps" : 0
          } ]
        }
      } ],
      "input_file" : {
        "duration" : 59,
        "duration_ms" : 0,
        "format" : "MOV",
        "size" : 2494653,
        "video_info" : {
          "width" : 480,
          "height" : 270,
          "bitrate" : 199,
          "bitrate_bps" : 0,
          "frame_rate" : 25000,
          "codec" : "HEVC"
        },
        "audio_info" : [ {
          "codec" : "AAC",
          "sample" : 48000,
          "channels" : 2,
          "bitrate" : 128,
          "bitrate_bps" : 0
        } ]
      }
    }
  } ]
}

Status code: 400

Failed to query the transcoding task.

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter"
}

Status Codes

Status Code	Description
200	Transcoding task queried successfully.
400	Failed to query the transcoding task.

Error Codes

See Error Codes.

Parent Topic: Transcoding APIs

Previous topic: Canceling a Transcoding Task

Next topic: Deletes Transcoding Task Records

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