文档首页> 视频直播 Live> 云直播API参考> 流监控> 查询推流监控数据接口
更新时间:2024-03-22 GMT+08:00
分享

查询推流监控数据接口

功能介绍

查询推流监控数据接口,包括帧率码率断流情况。

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

返回的码率数据列表粒度为1秒钟。

接口约束

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

publish_domain

String

推流域名。

app

String

应用名。

stream

String

流名。

start_time

String

起始时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

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

若参数为空,默认查询最近1小时数据。

end_time

String

结束时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

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

若参数为空,默认为当前时间。结束时间需大于起始时间。

请求参数

表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参数

参数

参数类型

描述

publish_domain

String

推流域名

app

String

应用名

stream

String

流名

video_framerate

Array of StreamDetail objects

展示流视频帧率情况,帧率单位为fps。

如果出现断流则会出现多个时间段流信息,如:

"video_framerate": [
    {
      "start_time": "2022-02-04T07:00:00Z",
      "end_time": "2022-02-04T07:00:02Z",
      "data_list": [
        21,
        22
      ]
    },
    {
      "start_time": "2022-02-04T07:00:05Z",
      "end_time": "2022-02-04T07:00:07Z",
      "data_list": [
        13,
        34,
        21
      ]
    }
  ]

video_bitrate

Array of StreamDetail objects

展示流视频码率情况,码率单位为Kbps。

如果出现断流则会出现多个时间段流信息,如:

"video_bitrate": [
    {
      "start_time": "2022-02-04T07:00:00Z",
      "end_time": "2022-02-04T07:00:02Z",
      "data_list": [
        1326,
        1268,
        775
      ]
    },
    {
      "start_time": "2022-02-04T07:00:05Z",
      "end_time": "2022-02-04T07:00:07Z",
      "data_list": [
        1021,
        2022
      ]
    }
  ]

audio_framerate

Array of StreamDetail objects

展示流音频帧率情况,帧率单位为fps。

如果出现断流则会出现多个时间段流信息,如:

"audio_framerate": [
    {
      "start_time": "2022-02-04T07:00:00Z",
      "end_time": "2022-02-04T07:00:02Z",
      "data_list": [
        10,
        17
      ]
    },
    {
      "start_time": "2022-02-04T07:00:05Z",
      "end_time": "2022-02-04T07:00:06Z",
      "data_list": [
        31,
        33
      ]
    }
  ]
表6 StreamDetail

参数

参数类型

描述

start_time

String

采样开始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。

end_time

String

采样结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。

data_list

Array of longs

流监控数据列表。

状态码: 400

表7 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识。

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询推流数据

GET /v2/{project_id}/stats/stream-detail?app=live&stream=pull_stream&publish_domain=livepush-test.huaweicloud.com

响应示例

状态码: 200

处理成功返回。

{
  "publish_domain" : "livepull-test.huaweicloud.com",
  "app" : "app",
  "stream" : "pull_stream",
  "video_framerate" : [ {
    "start_time" : "2022-02-04T07:00:00Z",
    "end_time" : "2022-02-04T07:00:02Z",
    "data_list" : [ 21, 22 ]
  }, {
    "start_time" : "2022-02-04T07:00:05Z",
    "end_time" : "2022-02-04T07:00:07Z",
    "data_list" : [ 13, 34, 21 ]
  } ],
  "video_bitrate" : [ {
    "start_time" : "2022-02-04T07:00:00Z",
    "end_time" : "2022-02-04T07:00:02Z",
    "data_list" : [ 1326, 1268, 775 ]
  }, {
    "start_time" : "2022-02-04T07:00:05Z",
    "end_time" : "2022-02-04T07:00:07Z",
    "data_list" : [ 1021, 2022 ]
  } ],
  "audio_framerate" : [ {
    "start_time" : "2022-02-04T07:00:00Z",
    "end_time" : "2022-02-04T07:00:02Z",
    "data_list" : [ 10, 17 ]
  }, {
    "start_time" : "2022-02-04T07:00:05Z",
    "end_time" : "2022-02-04T07:00:06Z",
    "data_list" : [ 31, 33 ]
  } ]
}

状态码: 400

处理失败返回。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: publish_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
48
49
50
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 ListSingleStreamDetailSolution {

    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");

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

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ListSingleStreamDetailRequest request = new ListSingleStreamDetailRequest();
        request.withPublishDomain("<publish_domain>");
        request.withApp("<app>");
        request.withStream("<stream>");
        request.withStartTime("<start_time>");
        request.withEndTime("<end_time>");
        try {
            ListSingleStreamDetailResponse response = client.listSingleStreamDetail(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
32
33
34
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListSingleStreamDetailRequest()
        request.publish_domain = "<publish_domain>"
        request.app = "<app>"
        request.stream = "<stream>"
        request.start_time = "<start_time>"
        request.end_time = "<end_time>"
        response = client.list_single_stream_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
38
39
40
41
42
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")

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

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

    request := &model.ListSingleStreamDetailRequest{}
	request.PublishDomain = "<publish_domain>"
	request.App = "<app>"
	request.Stream = "<stream>"
	startTimeRequest:= "<start_time>"
	request.StartTime = &startTimeRequest
	endTimeRequest:= "<end_time>"
	request.EndTime = &endTimeRequest
	response, err := client.ListSingleStreamDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

处理成功返回。

400

处理失败返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品