Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying Recording Channels
Updated on 2024-09-27 GMT+08:00
View PDF

Querying Recording Channels

Function

Queries the maximum number of recording channels per hour. The total number of recording channels in every minute of an hour is collected, and the maximum value is used as the statistical value.

The maximum query time span is 31 days. You can query data over the past one year.

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/record

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

publish_domain

No

String

Ingest domain name.

start_time

No

String

Start time. The format must comply with the ISO 8601 standard (UTC time) and is YYYY-MM-DDThh:mm:ssZ. The value will be rounded to the nearest hour. For example, if this parameter is set to 2020-08-18T07:20:40Z, the actual query start time will be 2020-08-18T07:00:00Z. If this parameter is left empty, data over the past 24 hours 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. The value will be rounded to the nearest hour. For example, if this parameter is set to 2020-08-18T08:20:40Z, the actual query end time will be 2020-08-18T08:00:00Z. If this parameter is left empty, 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 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

record_data_list

Array of RecordData objects

Sampled data list.
Table 6 RecordData

Parameter

Type

Description

concurrent_count

Integer

Maximum number of recording channels

time

String

Sampling time, that is, the time point when the maximum number of recording channels is reached in an hour. 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

Queries the duration of live recordings.

GET /v2/{project_id}/stats/record?start_time=2020-08-18T07:00:00Z&end_time=2020-08-18T08:00:00Z

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "record_data_list" : [ {
    "time" : "2020-08-18T07:00:00Z",
    "concurrent_count" : 20
  }, {
    "time" : "2020-08-18T08:00:00Z",
    "concurrent_count" : 15
  } ]
}

Status code: 400

Incorrect parameter.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: publish_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