Help Center> Live> API Reference> Statistics Analysis> Querying Upstream Bandwidth
View PDF

Querying Upstream Bandwidth

Function

This API is used to query the upstream bandwidth.

The maximum query time span is 31 days, and the maximum query period is 90 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/up-bandwidth/detail

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

publish_domains

Yes

Array

Ingest domain name list. A maximum of 10 domain names can be queried. Separate domain names with commas (,). If multiple domain names are queried, the combined data of multiple domain names is returned.

app

No

String

Application name

stream

No

String

Stream name

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.

interval

No

Integer

Interval for querying data. The value can be 300s (default value), 3,600s, or 86,400s. If this parameter is not set, the default value 300s is used.

start_time

No

String

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

The maximum query time range is 31 days. The maximum query period is 90 days. If this parameter is left blank, data over the past seven days is queried by default.

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 maximum query time span is 31 days, and the maximum query period is 90 days. 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.

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_list

Array of V2BandwidthData objects

Sampled data list
Table 6 V2BandwidthData

Parameter

Type

Description

value

Long

Bandwidth, in bit/s

time

String

Sampling time. 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/up-bandwidth/detail?publish_domains=play.example.com&start_time=2020-06-04T07:00:00Z&end_time=2020-06-05T07:00:00Z

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "data_list" : [ {
    "time" : "2020-06-04T07:00:00Z",
    "value" : 0
  }, {
    "time" : "2020-06-04T07:05:00Z",
    "value" : 325
  } ]
}

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