Help Center> Live> API Reference> Statistics Analysis> Querying the Duration of Transcoded Outputs
View PDF

Querying the Duration of Transcoded Outputs

Function

This API is used to query the duration of transcoded outputs per hour.

The maximum query time span is 31 days, and the maximum query period is 90 days.

Constraints

This API is used to query data of domain names added to the new Live console in the CN North-Beijing4 region. How Do I Check Whether a Domain Name Is In the New or Old Version? (https://support.huaweicloud.com/en-us/usermanual-live/live_01_0055.html)

URI

GET /v2/{project_id}/stats/transcode

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Obtaining a Project ID" .
Table 2 Query parameters

Parameter

Mandatory

Type

Description

publish_domain

No

String

Ingest domain name

start_time

No

String

Start time. The date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).

If this is set to 2020-08-18T07:20:40Z, the actual query start time is 2020-08-18T07:00:00Z (round to the hour).

If this parameter is left blank, data over the past 24 hours is queried by default.

end_time

No

String

End time. The date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).

If this is set to 2020-08-18T08:20:40Z, the actual query start time is 2020-08-18T08:00:00Z (round to the hour).

If this parameter is left blank, the current time is used by default. The end time must be later than the start time.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

The token is obtained by calling the IAM API used to obtain a user token. The token is the value of X-Subject-Token in the response header.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Sdk-Date

No

String

Time when the request is sent. 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.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Unique ID of the request
Table 5 Response body parameters

Parameter

Type

Description

transcode_data_list

Array of TranscodeData objects

Sampled data list

summary_list

Array of TranscodeSummary objects

Total duration of all transcoded outputs in a specified time range
Table 6 TranscodeData

Parameter

Type

Description

spec_list

Array of TranscodeSpec objects

Transcoding duration in each sampling period

time

String

Sampling time. The date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).
Table 7 TranscodeSpec

Parameter

Type

Description

type

String

Output specifications. The format is codec_resolution (low bitrate HD disabled) or codec_PVC_resolution (low bitrate HD enabled).

The codec can be H.264 or H.265. The resolution can be:

4K (3840x2160) or lower, 2K (2560x1440) or lower, FHD (1920x 080) or lower, HD (1280x720) or lower, or SD (640x480) or lower.

value

Double

Duration of transcoded outputs collected at each sampling time, in minutes. A maximum of two decimal places are allowed.
Table 8 TranscodeSummary

Parameter

Type

Description

type

String

Output specifications. The format is codec_resolution (low bitrate HD disabled) or codec_PVC_resolution (low bitrate HD enabled).

The codec can be H.264 or H.265. The resolution can be:

4K (3840x2160) or lower, 2K (2560x1440) or lower, FHD (1920x 080) or lower, HD (1280x720) or lower, or SD (640x480) or lower.

value

Double

Total duration of transcoded outputs, in minutes. A maximum of two decimal places are allowed.

Status code: 400

Table 9 Response header parameters

Parameter

Type

Description

X-request-id

String

Unique ID of the request
Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

GET /v2/{project_id}/stats/transcode?publish_domain=test.huawei.com&start_time=2020-08-18T07:00:00Z&end_time=2020-08-18T08:00:00Z

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "transcode_data_list" : [ {
    "time" : "2020-08-18T07:00:00Z",
    "spec_list" : [ {
      "type" : "H265_PVC_SD",
      "value" : 256.23
    }, {
      "type" : "H265_PVC_HD",
      "value" : 128.41
    } ]
  }, {
    "time" : "2020-08-18T08:00:00Z",
    "spec_list" : [ {
      "type" : "H265_PVC_SD",
      "value" : 52.35
    }, {
      "type" : "H265_PVC_HD",
      "value" : 136.32
    } ]
  } ],
  "summary_list" : [ {
    "type" : "H265_PVC_SD",
    "value" : 308.58
  }, {
    "type" : "H265_PVC_HD",
    "value" : 264.73
  } ]
}

Status code: 400

Parameter error

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: publish_domain"
}

Status Codes

Status Code

Description

200

This code is returned if the request succeeds.

400

Parameter error

Error Codes

See Error Codes.

Parent topic: Statistics Analysis