Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying HTTP Status Codes for Pulling Live Streams
Updated on 2024-09-27 GMT+08:00
View PDF

Querying HTTP Status Codes for Pulling Live Streams

Function

Queries HTTP status codes for pulling live streams.

HTTP status codes of a domain name in 1 minute will be returned.

The maximum query time span is 24 hours. You can query data over the past seven days.

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

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

play_domains

Yes

Array

Streaming domain name list. Up to 100 domain names can be queried. Separate domain names with commas (,).

code

No

Array

Status code

isp

No

Array

Carrier list. Possible values:

  • CMCC: China Mobile

  • CTCC: China Telecom

  • CUCC: China Unicom

  • OTHER: other carriers

If this parameter is not specified, information about all carriers is queried.

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

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

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 blank, the current time is used by default. The end time must be later than the start time.

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

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

data_series

Array of HttpCodeSummary objects

Time-based status code statistics.
Table 6 HttpCodeSummary

Parameter

Type

Description

http_codes

Array of HttpCode objects

Status code information

time

String

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

Parameter

Type

Description

code

Integer

Status code

count

Integer

Number of times a status code is displayed

proportion

Double

Percentage of the status code at the corresponding time point. A maximum of four decimal places are allowed.

Status code: 400

Table 8 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique ID of the request.
Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Queries streaming status codes of a streaming domain name.

GET /v2/{project_id}/stats/httpcodes?play_domains=livepull-test.huaweicloud.com&start_time=2020-07-23T07:00:00Z&end_time=2020-07-23T08:00:00Z

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "data_series" : [ {
    "time" : "2020-06-04T07:00:00Z",
    "http_codes" : [ {
      "code" : 200,
      "count" : 750,
      "proportion" : 0.5211
    }, {
      "code" : 400,
      "count" : 650,
      "proportion" : 0.4789
    } ]
  }, {
    "time" : "2020-06-04T07:01:00Z",
    "http_codes" : [ {
      "code" : 200,
      "count" : 1000,
      "proportion" : 1
    }, {
      "code" : 400,
      "count" : 0,
      "proportion" : 0
    } ]
  } ]
}

Status code: 400

Incorrect parameter.

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

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