获取实时公共流订阅数据 ListRealTimePublicStreamInfo--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取实时公共流订阅数据 ListRealTimePublicStreamInfo

最近更新时间：2024.11.29 11:10:17首次发布时间：2024.11.29 11:10:17

在实时音视频通话场景中，你可以使用此接口查询一段时间内，某个应用的公共流订阅数据。

使用说明

指标聚合时间为 30s，若查询间隔包含第 0 s 或 30 s，会返回对应时间点的数据，否则为空。

注意事项

最大请求次数：10 次/秒
最远可查询时间：30 天
最大单次查询时间跨度：120 分钟
数据延迟：60 秒

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=ListRealTimePublicStreamInfo&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRealTimePublicStreamInfo`	接口名称。当前 API 的名称为 `ListRealTimePublicStreamInfo`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
StreamId	String	否	`stream1`	要查询的公共流 ID，多个用户流 ID 用逗号隔开。若不填则查询当前 AppId 下所有公共流。
StartTime	String	是	`2024-11-07T00:00:00+08:00`	查询起始时间戳，格式为 `RFC3339`，单位为秒。
EndTime	String	是	`2024-11-08T00:00:00+08:00`	查询结束时间戳，格式为 `RFC3339`，单位为秒。
Indicator	String[]	是	`["pull_num"]`	查询的指标名称，目前仅支持 `pull_num`(订阅数）

返回参数

参数	类型	示例值	描述
Indicators	Object[]		公共流指标详细信息
Name	String	`pull_num`	查询指标名称
Unit	String	`-`	查询指标单位
Data	Object[]	`-`	查询指标详细信息
Value	Double	`99.99`	指标值，浮点数，保留两位小数。
TimeStamp	String	`2021-07-24T00:00:00+08:00`	指标聚合时间，即指标值对应时间段的开始时刻（每 30s 一聚合）。格式为 RFC3339 规范。
StreamId	String	`stream1`	查询公共流 ID

请求示例

POST https://rtc.volcengineapi.com?Action=ListRealTimePublicStreamInfo&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "StartTime": "2024-11-11T10:00:00+08:00",
    "EndTime": "2024-11-11T12:00:00+08:00",
    "Indicator": ["pull_num"],
    "StreamId": "steam1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "021731****ee00f6f",
        "Action": "ListRealTimePublicStreamInfo",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Indicators": [
            {
                "Name": "pull_num",
                "Unit": "",
                "Data": [
                    {
                        "TimeStamp": "2024-11-11T10:00:00+08:00",
                        "Value": 1,
                        "StreamId": "AC22010021123"
                    },
                    {
                        "TimeStamp": "2024-11-11T10:00:30+08:00",
                        "Value": 1,
                        "StreamId": "AC22010021123"
                    }
                ]
            }
        ]
    }
}