Help Center> Live> API Reference> Stream Analytics> Querying the Stream Frame Rate
View PDF

Querying the Stream Frame Rate

Function

This API is used to query the stream frame rate.

The maximum query time span is 6 hours, and the maximum query period is 7 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/stream/framerate

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

domain

Yes

String

Ingest domain name

app

Yes

String

Application name

stream

Yes

String

Stream name

start_time

No

String

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

The maximum query time span is 6 hours, and the maximum query period is 7 days.

If this parameter is left blank, data of the last hour 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 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

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 date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).

end_time

String

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

data_list

Array of integers

Frame rate list

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

GET /v2/{project_id}/stats/stream/framerate?app=live&stream=pull_stream&domain=example.huawei.com

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "framerate_info_list" : [ {
    "publish_domain" : "example.huawei.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