Help Center/ Live/ Cloud Live API Reference/ Statistics Analysis/ Querying the Distribution of Live Streaming Metrics by Region
Updated on 2024-08-09 GMT+08:00

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 over 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.

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

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

Interval for querying data (in seconds). The value can be 300 (default value), 3600, or 86,400. If this parameter is left empty, the default value 300 is used.

Note: If the value of metric is player (number of viewers), the value of interval will be defaulted to 60 seconds.

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.

area

Yes

Array

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:00:00Z&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"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v2.region.LiveRegion;
import com.huaweicloud.sdk.live.v2.*;
import com.huaweicloud.sdk.live.v2.model.*;


public class ListAreaDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAreaDetailRequest request = new ListAreaDetailRequest();
        try {
            ListAreaDetailResponse response = client.listAreaDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v2.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAreaDetailRequest()
        response = client.list_area_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAreaDetailRequest{}
	response, err := client.ListAreaDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

This code is returned if the request succeeds.

400

Incorrect parameter.

Error Codes

See Error Codes.