Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying the Duration of Transcoded Outputs
Updated on 2024-09-27 GMT+08:00
View PDF

Querying the Duration of Transcoded Outputs

Function

Queries the transcoded output duration per hour.

The maximum query time span is 31 days. You can query data over the past one year.

Data about the transcoded output duration is delayed for one hour.

Constraints

Only the data of domain names added to the new Live console in regions excluding CN North-Beijing1 can be queried. This restriction applies only to the HUAWEI CLOUD Chinese Mainland website.

Calling Method

For details, see Calling APIs.

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 the project ID, see Obtaining a Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

publish_domain

No

String

Ingest domain name.

stream

No

String

Stream name.

start_time

No

String

Start time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. The value will be rounded to the nearest hour. For example, if this parameter is set to 2020-08-18T07:20:40Z, the actual query start time will be 2020-08-18T07:00:00Z. If this parameter is left empty, data over the past 24 hours is queried by default.

end_time

No

String

End time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ.

The value will be rounded to the nearest hour. For example, if this parameter is set to 2020-08-18T08:20:40Z, the actual query start time will be 2020-08-18T08:00:00Z.

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

NOTE:

If the expenditures of a pay-per-use resource are charged by hour or day, the resource usage for the final settlement period of one month is deducted on the first day of the next month and settled in the next month.

Example: The expenditures of pay-per-use resources are charged by hour.

The transcoding usage from 2021/11/30 23:00:00 to 2021/12/01 00:00:00 started to be reported to the billing system at 2021/12/01 00:00:00.

The billing system deducted the fee at 2021/12/01 00:36:00.

The usage duration was from 2021/11/30 23:00:00 to 2021/12/01 00:00:00, and the transaction time was 2021/12/01 00:00. Therefore, the corresponding expenditures were included in the bill for the billing cycle of December 2021.

Request Parameters

Table 3 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 a token.

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, which is the same as that used in the URI. This parameter is mandatory when AK/SK-based authentication is used.

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 format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ.
Table 7 TranscodeSpec

Parameter

Type

Description

type

String

Output specifications. The format is codec_resolution (low-bitrate HD disabled) or codecPVCresolution (low-bitrate HD enabled). The codec format can be H.264 or H.265. The resolution can be 4K (3840 x 2160) and lower, 2K (2560 x 1440) and lower, FHD (1920 x 1080) and lower, HD (1280 x 720) and lower, or SD (640 x 480) and 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 codecPVCresolution (low-bitrate HD enabled). The codec format can be H.264 or H.265. The resolution can be 4K (3840 x 2160) and lower, 2K (2560 x 1440) and lower, FHD (1920 x 1080) and lower, HD (1280 x 720) and lower, or SD (640 x 480) and lower.

value

Double

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

Codecs include H.264 and H.265. Resolution levels include:

      4K (3840 x 2160) or lower, 2K (2560 x 1440) or lower, FHD (1920 x 1080) or lower, HD (1280 x 720) or lower, and SD (640 x 480) or lower.

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

Queries the transcoding usage of an ingest domain name.

GET /v2/{project_id}/stats/transcode?publish_domain=livepull-test.huaweicloud.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

Incorrect parameter.

{
  "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

Incorrect parameter.

Error Codes

See Error Codes.

Parent Topic: Statistics Analysis