Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying the Historical Stream List
Updated on 2024-09-27 GMT+08:00
View PDF

Querying the Historical Stream List

Function

Queries the historical stream list.

Ongoing streams cannot be queried.

The maximum query time span is one day.

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/history/streams

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

No

String

Application name.

stream

No

String

Stream name.

start_time

No

String

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

The format is YYYY-MM-DDThh:mm:ssZ. The maximum query time span is one day.

If this parameter is left empty, data over the past one day 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 empty, the current time is used by default. The maximum query time span is one day. The end time must be later than the start time.

offset

No

Integer

Page number. The default value is 0.

limit

No

Integer

Number of records on each page.

Value range: 1 to 100.

Default value: 10

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

history_stream_list

Array of HistoryStreamInfo objects

Historical stream list

total

Integer

Total number of records
Table 6 HistoryStreamInfo

Parameter

Type

Description

domain

String

Ingest domain name

  • If the value of type is 0, the value of this parameter is the streamer's ingest domain name.

  • If the value of type is 1, the value of this parameter is a third-party ingest domain name.

app

String

Application name.

stream

String

Stream name.

type

Integer

Stream push type. Possible values:

  • 0: stream push by the streamer

  • 1: stream push by a third party

video_codec

String

Video codec

audio_codec

String

Audio codec

client_ip

String

IP address of the streamer

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.

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 historical pushed streams of a domain name.

GET /v2/{project_id}/stats/history/streams?domain=livepull-test.huaweicloud.com&limit=10&offset=1

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "history_stream_list" : [ {
    "domain" : "livepull-test.huaweicloud.com",
    "app" : "live",
    "stream" : "pull",
    "type" : 0,
    "video_codec" : "H264",
    "audio_codec" : "AAC",
    "client_ip" : "127.0.0.1",
    "start_time" : "2020-06-04T07:00:00Z",
    "end_time" : "2020-06-05T07:00:00Z"
  } ],
  "total" : 100
}

Status code: 400

Incorrect parameter.

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

Incorrect parameter.

Error Codes

See Error Codes.

Parent Topic: Statistics Analysis