Help Center/ Media Processing Center/ API Reference/ Transcoding APIs/ Queries Task Overview
Updated on 2023-12-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Queries Task Overview

Function

Queries the task duration statistics of the past week, past month, or a user-defined time period.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/transcodings/summaries

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

start_time

Yes

String

Start time. The format is yyyymmdd. The value must be a UTC time irrelevant to the time zone.

end_time

Yes

String

End time. The format is yyyymmdd. The value must be a UTC time irrelevant to the time zone.

stat_type

Yes

String

Specifies the statistics type. The options are as follows:

  • video_duration: duration of the transcoded media file, in minutes

  • remux_file_duration: duration of the packaged media file, in minutes

  • transcode_task_number: number of transcoding times

  • transcode_duration: transcoding duration, in minutes

Request Parameters

Table 3 Request header 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

Table 4 Response body parameters

Parameter

Type

Description

summary

Array of StatSummary objects

Statistics overview

total

Float

Indicates the total value of the metric. The value is accurate to two decimal places.

stat_type

String

Specifies the statistics type. The options are as follows:

  • video_duration: duration of the transcoded media file, in minutes

  • remux_file_duration: duration of the packaged media file, in minutes

  • transcode_task_number: number of transcoding times

  • transcode_duration: transcoding duration, in minutes
Table 5 StatSummary

Parameter

Type

Description

value

Float

The value is accurate to two decimal places.

date

String

Date, accurate to day. Format example: 2018/03/01.

Status code: 400

Table 6 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/summaries?start_time=20221119&end_time=20221125&stat_type=transcode_task_number

Example Responses

Status code: 200

Transcoding overview information has been queried.

{
  "stat_type" : "transcode_task_number",
  "total" : 5.0,
  "summary" : [ {
    "value" : "2.0",
    "date" : "2022/11/25"
  }, {
    "value" : "3.0",
    "date" : "2022/11/25"
  } ]
}

Status code: 400

Transcoding overview information cannot be queried.

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter, start_time cannot be greater than end_time."
}

Status Codes

Status Code

Description

200

Transcoding overview information has been queried.

400

Transcoding overview information cannot be queried.

Error Codes

See Error Codes.

Parent Topic: Transcoding APIs