更新时间:2024-07-25 GMT+08:00
分享

查询播放画像信息接口

功能介绍

查询播放画像信息。

最大查询跨度1天,最大查询周期31天。

该接口仅支持查询FLV和RTMP流的在线人数。

接口约束

该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/stats/stream-portraits

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

play_domain

String

播放域名。

stream

String

流名。

time

String

统计日期,日期格式按照ISO8601表示法,格式:YYYYMMDD,如20200904。可以查询过去31天的数据(不含当天)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识。

表5 响应Body参数

参数

参数类型

描述

stream_portraits

Array of StreamPortrait objects

播放画像信息列表。

表6 StreamPortrait

参数

参数类型

描述

time

String

统计日期,日期格式按照ISO8601表示法,格式:YYYYMMDD,如20200904。统计该统计日期00:00-23:59时段的播放画像信息。

flow

Long

累计流量,单位为byte。

play_duration

Long

累计播放时长,单位为秒。

request_count

Long

累计请求次数。

user_count

Long

累计观看人数,根据IP去重。

peak_user_count

Long

峰值观看人数,flv/rtmp协议是统计Session会话ID,其它协议统计IP,1分钟的采样数据。

peak_bandwidth

Long

峰值带宽,单位bps,5分钟的采样数据。

push_duration

Long

累计直播(推流)时长,单位为秒。

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询播放域名流画像

GET /v2/{project_id}/stats/stream-portraits?play_domain=livepull-test.huaweicloud.com&stream=stream-000&time=20200904

响应示例

状态码: 200

处理成功返回。

{
  "stream_portraits" : [ {
    "time" : 20200812,
    "flow" : 10,
    "play_duration" : 10,
    "request_count" : 10,
    "user_count" : 10,
    "peak_user_count" : 10,
    "peak_bandwidth" : 10,
    "push_duration" : 10
  } ]
}

状态码: 400

参数错误。

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

SDK代码示例

SDK代码示例如下。

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

    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();
        ShowStreamPortraitRequest request = new ShowStreamPortraitRequest();
        try {
            ShowStreamPortraitResponse response = client.showStreamPortrait(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 = ShowStreamPortraitRequest()
        response = client.show_stream_portrait(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.ShowStreamPortraitRequest{}
	response, err := client.ShowStreamPortrait(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

处理成功返回。

400

参数错误。

错误码

请参见错误码

相关文档