Help Center/ Live/ Cloud Live API Reference/ Stream Analytics/ Queries CDN upstream streaming quality data
Updated on 2024-09-27 GMT+08:00
View PDF

Queries CDN upstream streaming quality data

Function

Queries CDN upstream streaming quality data

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

The returned CDN upstream streaming quality data is accurate to one minute.

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/up-stream/detail

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

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).

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).

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, 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 that is used to obtain a user token. The value of X-Subject-Token in the response header is the user 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 ID 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

data

Array of UpStreamDetail objects

Streaming quality data
Table 6 UpStreamDetail

Parameter

Type

Description

time

String

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

fps

Long

Frame rate

Unit: FPS

rate

Long

Bitrate

Unit: kbit/s

delay

Long

Latency

Unit: ms

gop_duration

Long

Duration of the latest GOP

Unit: ms

last_video_pts

Long

Video PTS

Unit: ms

last_audio_pts

Long

Audio PTS

Unit: ms

last_video_audio_pts_diff

Long

Audio/Video PTS difference

Unit: ms

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 details about an ingest domain name.

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

Example Responses

Status code: 200

The information is returned when the request succeeded.

{
  "publish_domain" : "livepush-test.huaweicloud.com",
  "app" : "stage",
  "stream" : "stream-7159441965564594945",
  "data" : [ {
    "fps" : 29,
    "rate" : 8191,
    "delay" : 225,
    "gop_duration" : 1999,
    "last_video_pts" : 1224054,
    "last_audio_pts" : 1224054,
    "last_video_audio_pts_diff" : 0,
    "time" : "2020-04-23T07:00:00Z"
  }, {
    "fps" : 28,
    "rate" : 184,
    "delay" : 0,
    "gop_duration" : 0,
    "last_video_pts" : 10135133,
    "last_audio_pts" : 10135125,
    "last_video_audio_pts_diff" : 8,
    "time" : "2020-04-23T07:00:00Z"
  } ]
}

Status code: 400

The information is returned when the request failed.

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

Status Codes

Status Code

Description

200

The information is returned when the request succeeded.

400

The information is returned when the request failed.

Error Codes

See Error Codes.

Parent Topic: Stream Analytics