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

Querying the Stream Push Frame Rate

Function

Queries the stream frame rate.

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

The granularity of the returned frame rate data is one second.

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/stream/framerate

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

domain

Yes

String

Ingest domain name.

app

Yes

String

Application name.

stream

Yes

String

Stream name.

start_time

No

String

Start time. The format must comply with the ISO 8601 standard (UTC time).

Format: 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.

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. 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 for AK/SK authentication.

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

framerate_info_list

Array of V2FramerateInfo objects

Usage details.
Table 6 V2FramerateInfo

Parameter

Type

Description

publish_domain

String

Ingest domain name.

app

String

Application name.

stream

String

Stream name.

start_time

String

Time when sampling starts. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ.

end_time

String

Time when sampling ends. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ.

data_list

Array of longs

List of frame rates, in fps.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique ID of the request.
Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Queries the frame rate of an ingest domain name.

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

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "framerate_info_list" : [ {
    "publish_domain" : "livepush-test.huaweicloud.com",
    "app" : "live",
    "stream" : "pull",
    "start_time" : "2020-06-04T07:00:00Z",
    "end_time" : "2020-06-05T07:00:00Z",
    "data_list" : [ 10, 20 ]
  } ]
}

Status code: 400

This code is returned if the request failed to be fulfilled.

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

Status Codes

Status Code

Description

200

This code is returned if the request succeeds.

400

This code is returned if the request failed to be fulfilled.

Error Codes

See Error Codes.

Parent Topic: Stream Analytics