Help Center/ Live/ Cloud Live API Reference/ Stream Analytics/ Querying the Stream Push Monitoring Data
Updated on 2024-09-27 GMT+08:00
View PDF

Querying the Stream Push Monitoring Data

Function

Queries stream push monitoring data, including the frame rate, bitrate, and stream interruption.

The maximum query time span is one day. You can query data over the past seven days.

The granularity of the returned bitrate data is one second.

Constraints

Queries only the data of domain names deployed on the new Live service (excluding CN North-Beijing1). This constraint applies only to the Huawei Cloud Chinese Mainland website.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/stats/stream-detail

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

Yes

String

Ingest domain name

app

Yes

String

App name

stream

Yes

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 maximum query time span is one day. You can query data over the past seven days.

If this parameter is not specified, data over the past hour 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 maximum query time span is one day. You can query data over the past seven days.

If this parameter is not specified, the current time will be 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. 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 for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID, which is the same as that used in the URI. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique identifier of the request
Table 5 Response body parameters

Parameter

Type

Description

publish_domain

String

Ingest domain name

app

String

App name

stream

String

Stream name

video_framerate

Array of StreamDetail objects

Displays the frame rate of a video stream, in FPS.

If stream interruption occurs, stream information in multiple time segments is displayed. For example:

"video_framerate": [
    {
      "start_time": "2022-02-04T07:00:00Z",
      "end_time": "2022-02-04T07:00:02Z",
      "data_list": [
        21,
        22
      ]
    },
    {
      "start_time": "2022-02-04T07:00:05Z",
      "end_time": "2022-02-04T07:00:07Z",
      "data_list": [
        13,
        34,
        21
      ]
    }
  ]

video_bitrate

Array of StreamDetail objects

Displays the bitrate of a video stream, in kbit/s.

If stream interruption occurs, stream information in multiple time segments is displayed. For example:

"video_bitrate": [
    {
      "start_time": "2022-02-04T07:00:00Z",
      "end_time": "2022-02-04T07:00:02Z",
      "data_list": [
        1326,
        1268,
        775
      ]
    },
    {
      "start_time": "2022-02-04T07:00:05Z",
      "end_time": "2022-02-04T07:00:07Z",
      "data_list": [
        1021,
        2022
      ]
    }
  ]
Table 6 StreamDetail

Parameter

Type

Description

start_time

String

Sampling start time. The date format complies with the ISO 8601 standard and the UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ.

end_time

String

Sampling end time. The date format complies with the ISO 8601 standard and the UTC time is used. The format is YYYY-MM-DDThh:mm:ssZ.

data_list

Array of longs

Stream monitoring data list

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique identifier of the request
Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Queries streaming data.

GET /v2/{project_id}/stats/stream-detail?app=live&stream=pull_stream&publish_domain=livepush-test.huaweicloud.com

Example Responses

Status code: 200

Information is returned when the processing is successful.

{
  "publish_domain" : "livepull-test.huaweicloud.com",
  "app" : "app",
  "stream" : "pull_stream",
  "video_framerate" : [ {
    "start_time" : "2022-02-04T07:00:00Z",
    "end_time" : "2022-02-04T07:00:02Z",
    "data_list" : [ 21, 22 ]
  }, {
    "start_time" : "2022-02-04T07:00:05Z",
    "end_time" : "2022-02-04T07:00:07Z",
    "data_list" : [ 13, 34, 21 ]
  } ],
  "video_bitrate" : [ {
    "start_time" : "2022-02-04T07:00:00Z",
    "end_time" : "2022-02-04T07:00:02Z",
    "data_list" : [ 1326, 1268, 775 ]
  }, {
    "start_time" : "2022-02-04T07:00:05Z",
    "end_time" : "2022-02-04T07:00:07Z",
    "data_list" : [ 1021, 2022 ]
  } ]
}

Status code: 400

Information is returned when the processing fails.

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

Status Codes

Status Code

Description

200

Information is returned when the processing is successful.

400

Information is returned when the processing fails.

Error Codes

See Error Codes.

Parent Topic: Stream Analytics