Help Center> Live> API Reference> Statistics Analysis> Querying the Historical Stream List
View PDF

Querying the Historical Stream List

Function

This API is used to query the historical stream list.

The maximum query time span is 1 day, 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/history/streams

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

No

String

Application name

offset

No

Integer

Page number. The default value is 0.

limit

No

Integer

Number of records on each page

Value range: 1–100

Default value: 10

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

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 type is 0, this parameter value is the name of the streamer's ingest domain name.

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

app

String

Application name

stream

String

Stream name

type

Integer

Stream push type. Possible values are:

  • 0: stream push by the streamer

  • 1: third-party stream push

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

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/history/streams?domain=play.example.com&limit=10&offset=1

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "history_stream_list" : [ {
    "domain" : "example.huawei.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

Parameter error

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

Parameter error

Error Codes

See Error Codes.

Parent topic: Statistics Analysis