Help Center> Live> API Reference> Statistics Analysis> Querying HTTP Status Codes for Pulling Live Streams
View PDF

Querying HTTP Status Codes for Pulling Live Streams

Function

This API is used to query HTTP status codes for pulling live streams. The interval for query is one minute. The maximum query time span cannot exceed 24 hours, 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/httpcodes

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

play_domains

Yes

Array

Streaming domain name list. A maximum of 10 domain names can be queried. Separate domain names with commas (,).

code

No

Array

Status code

region

No

Array

Region list. For details about the value, see Abbreviations for Provinces. If this parameter is not set, all regions are queried.

isp

No

Array

Carrier list. Possible values are:

  • CMCC: China Mobile

  • CTCC: China Telecom

  • CUCC: China Unicom

  • OTHER

If this parameter is not set, all carriers are queried.

start_time

No

String

Start time. The date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).

If this parameter is left blank, data of the last hour is queried by default.

The maximum query time span is 1 day, and the maximum query period is 7 days.

end_time

No

String

End time. The date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).

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 1 day, and the maximum query period is 7 days.

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

data_series

Array of HttpCodeSummary objects

Status codes by time
Table 6 HttpCodeSummary

Parameter

Type

Description

http_codes

Array of HttpCode objects

Status code information

time

String

Sampling time. The date format is ISO 8601 compliant and is YYYY-MM-DDThh:mm:ssZ (UTC time).
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

GET /v2/{project_id}/stats/httpcodes?play_domains=example.huawei.com,example1.huawei.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

Parameter error

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

Parameter error

Error Codes

See Error Codes.

Parent topic: Statistics Analysis