Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying the Distribution of Live Streaming Metrics by Region

Updated on 2025-12-03 GMT+08:00

View PDF

Querying the Distribution of Live Streaming Metrics by Region

Function

Queries detailed livestreaming data by region.

If no domain name is specified, the detailed data of all streaming domain names of the tenant is queried.

When tenant-level data is queried, the app and stream parameters do not take effect.

The maximum query time span is one day. You can query data from the past 90 days.

When viewer data is queried, only the number of online users of FLV and RTMP streams can be queried.

Data of the current day can be queried. The data delay is less than five minutes.

If the data is used for reconciliation, query the data generated three hours ago.

Domain name information is synchronized every hour. You can query the data one hour after the domain name is created.
When you specify a start time and end time, the start time must align with an exact time point based on the query granularity, and the end time must be set to one unit less than the exact time point (not inclusive of the boundary).

For example, with a 5-minute query granularity, the start time must align with an exact 5-minute mark, such as, 0, 5, 50, 55 minutes, and the end time must be one second before the next interval, such as, 4 minutes 59 seconds, 9 minutes 59 seconds, and 59 minutes 59 seconds. If the start_time and end_time parameters are set to 2020-06-04T07:00:00Z and 2020-06-04T07:04:59Z, respectively, the data within the 5-minute interval is queried. If the query does not comply with the preceding specifications, the returned data may be different from the expected data.

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/stats/area/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
start_time	Yes	String	Queries start time. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ. The maximum query time span is one day. You can query data over the past 90 days.
end_time	Yes	String	Queries end time. The format must comply with the ISO 8601 standard (UTC time). The format is YYYY-MM-DDThh:mm:ssZ. The maximum query time span is one day. You can query data over the past 90 days.
play_domains	No	Array of strings	List of streaming domain names to be queried. A maximum of 100 domain names can be queried.
app	No	String	App to be queried.
stream	No	String	Stream name.
interval	No	Integer	Time granularity for querying data. Unit: second The value can be 300s (default value), 3,600s, or 86,400s. If this parameter is not set, the default value 300s is used. Note: If metric is set to player (number of viewers), the specified value of interval does not take effect, and its default value 60s will be used. The query granularity must be smaller than the query span. For example, if the difference between end_time and start_time is 86,400s (1 day), the granularity must be shorter than 86,400s.
isp	No	Array of strings	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.
area	Yes	Array of strings	Huawei Cloud billing region to be queried. Possible options: CN: Chinese mainland AP1: Asia-Pacific 1 AP2: Asia-Pacific 2 AP3: Asia Pacific 3 MEAA: Middle East and Africa SA: Latin America EU: Europe ALL: All regions The result of the Chinese mainland is the name of the province or municipality, for example, Guangdong and Shanghai. For the mapping between Huawei Cloud regions outside China and regions/countries, see Region/Country Code Mapping Table.
metric	Yes	String	Metric. Possible values: bandwidth: bandwidth traffic: traffic player: number of viewers
protocol	No	String	Request protocol. Possible values: flv hls

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_list	Array of AreaDetail objects	Timestamp and metric value at the corresponding time.

**Table 6** AreaDetail
Parameter	Type	Description
area	String	Name of a charging region, for example, CN.
summary	Array of TimeValue objects	Timestamp and metric value at the corresponding time.
detail	Array of AreaTimeValue objects	Timestamps of provinces, regions, or countries in each charging region and metric values at the corresponding time.

**Table 7** AreaTimeValue
Parameter	Type	Description
name	String	Name of a province, region, or country in a Huawei Cloud region. The result of the Chinese mainland is the Chinese name of the province or municipality, for example, Guangdong and Shanghai. For the mapping between Huawei Cloud regions outside China and regions/countries, see Region/Country Code Mapping Table.
data	Array of TimeValue objects	Value of the specified metric at the time specified by the timestamp.

**Table 8** TimeValue
Parameter	Type	Description
time	String	Sampling time (UTC), which complies with the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ.
value	Long	Value of the specified metric at the time specified by the timestamp.

Status code: 400

**Table 9** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Unique ID of the request.

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error description

Example Requests

Queries details about streaming domain name metrics in regional livestreaming.

GET /v2/{project_id}/stats/area/detail?start_time=2021-12-20T07:00:00Z&end_time=2021-12-20T07:09:59Z&play_domains=livepull-test.huaweicloud.com&area=CN&metric=traffic

Example Responses

Status code: 200

This code is returned if the request succeeds.

{
  "data_list" : [ {
    "area" : "AP2",
    "summary" : [ {
      "time" : "2021-12-20T07:00:00Z",
      "value" : 323
    }, {
      "time" : "2021-12-20T09:05:00Z",
      "value" : 325
    } ],
    "detail" : [ {
      "name" : "TH",
      "data" : [ {
        "time" : "2021-12-20T07:00:00Z",
        "value" : 223
      }, {
        "time" : "2021-12-20T09:05:00Z",
        "value" : 123
      } ]
    }, {
      "name" : "PH",
      "data" : [ {
        "time" : "2021-12-20T07:00:00Z",
        "value" : 123
      }, {
        "time" : "2021-12-20T09:05:00Z",
        "value" : 223
      } ]
    } ]
  } ]
}

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

Previous topic: Querying the Playback Profile

Next topic: Stream Analytics

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel