DescribeLiveSourceTrafficData - 查询直播流或域名的回源流量监控数据--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveSourceTrafficData - 查询直播流或域名的回源流量监控数据

最近更新时间：2025.04.22 19:10:54首次发布时间：2023.09.25 14:36:18

调用 DescribeLiveSourceTrafficData 接口，查询指定时间范围内拉流域名或回源流产生的回源流量和带宽监控数据。

注意事项

请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：时间粒度为 60 秒时，数据延迟为 5 分钟；其他时间粒度时，数据延迟为 15 分钟。
数据进制：
- 流量数据统计进制为 1000，例如，1 GB = 1000 MB。
- 带宽数据统计进制为 1000，例如，1 Mbps = 1000 Kbps。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["pull.example.com", "pull2.example.com"]`	拉流域名列表，默认为空，表示查询所有域名的回源流量带宽监控数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。说明 `DomainList` 和 `Domain` 传且仅传一个。
Domain	String	否	`pull.example.com`	拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。说明查询流粒度数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
App	String	否	`live`	回源流的应用名称，查询流粒度数据时必传，且需同时传入 `Domain` 和 `Stream`。支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 30 个字符。说明查询流粒度数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
Stream	String	否	`example_stream`	回源流的流名称，查询流粒度数据时必传，且需同时传入 `Domain` 和 `App`。支持由大小写字母（A - Z、a - z）、下划线（_）、短横线（-）和句点（.）组成，长度为 1 到 100 个字符。说明查询流粒度数据时，需同时指定 `Domain` 、`App` 和 `Stream` 来指定回源流。
ISPList	Array of String	否	`["telecom"]`	提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
UserRegionList	Array of UserRegionList	否	`-`	客户端 IP 所属区域的列表，缺省情况下表示所有区域。
Aggregation	Integer	否	`300`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `60`：1 分钟。 `300`：（默认值）5 分钟。 `3600`：1 小时。
DetailField	Array of String	否	`["Domain"]`	数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。 `Domain`：域名； `ISP`：运营商。说明配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。说明历史查询最大时间范围为 366 天，单次查询最大时间跨度与数据拆分维度和数据聚合时间粒度有关，详细如下。当不进行维度拆分或只使用一个维度拆分数据时：数据以 60 秒聚合时，单次查询最大时间跨度为 24 小时；数据以 300 秒聚合时，单次查询最大时间跨度为 31 天；数据以 3600 秒聚合时，单次查询最大时间跨度为 31 天。当使用两个或两个以上维度拆分数据时：数据以 60 秒聚合时，单次查询最大时间跨度为 3 小时；数据以 300 秒聚合时，单次查询最大时间跨度为 24 小时；数据以 3600 秒聚合时，单次查询最大时间跨度为 7 天。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。

UserRegionList

参数	类型	是否必选	示例值	描述
Area	String	否	`CN`	区域信息中的大区标识符，如何获取请参见查询区域标识符。
Country	String	否	`CN`	区域信息中的国家标识符，如何获取请参见查询区域标识符。如果按国家筛选，需要同时传入 `Area` 和 `Country`。
Province	String	否	`beijing`	区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见查询区域标识符。如果按省筛选，需要同时传入 `Area`、`Country` 和 `Province`。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
DomainList	Array of String	`["push.example.com", "push2.example.com"]`	域名列表。
Domain	String	`push.example.com`	查询流粒度数据时的域名。
App	String	`live`	查询流粒度数据时的应用名称。
Stream	String	`example_stream`	查询流粒度数据时的流名称。
ISPList	Array of String	`["telecom"]`	提供网络接入服务的运营商标识符，标识符与运营商的对应关系如下。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。
UserRegionList	Array of UserRegionList	`-`	客户端 IP 所属区域列表。
DetailField	Array of String	`["Domain"]`	数据拆分的维度，维度说明如下所示。 `Domain`：域名； `ISP`：运营商。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`300`	聚合的时间粒度，单位为秒。 `60`：1 分钟； `300`：5 分钟； `3600`：1 小时。
TotalTraffic	Float	`20`	查询时间范围内的回源总流量，单位为 GB。
PeakBandwidth	Float	`10`	查询时间范围内的回源峰值带宽，单位为 Mbps。
TrafficDataList	Array of TrafficDataList	`-`	所有时间粒度的数据。
TrafficDetailDataList	Array of TrafficDetailDataList	`-`	按维度拆分后的数据。

UserRegionList

参数	类型	示例值	描述
Area	String	`CN`	区域信息中的大区标识符。
Country	String	`CN`	区域信息中的国家标识符。
Province	String	`beijing`	区域信息中的省份标识符。

TrafficDataList

参数	类型	示例值	描述
TimeStamp	String	`2022-04-13T00:00:00+08:00`	数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。
Traffic	Float	`20`	当前数据聚合时间粒度内产生的回源流量，单位 GB。
Bandwidth	Float	`10`	当前数据聚合时间粒度内的回源峰值带宽，单位为 Mbps。

TrafficDetailDataList

参数	类型	示例值	描述
Domain	String	`push.example.com`	按域名维度进行数据拆分时的域名信息。
ISP	String	`telecom`	按运营商维度进行数据拆分时的运营商信息。
TotalTraffic	Float	`20`	按维度进行数据拆分后，当前维度的回源总流量，单位为 GB。
PeakBandwidth	Float	`10`	按维度进行数据拆分后，当前维度的回源峰值带宽，单位为 Mbps。
TrafficDataList	Array of TrafficDataList	`-`	按维度进行数据拆分后，当前维度下所有时间粒度的数据。

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveSourceTrafficData&Version=2023-01-01
{
    "DomainList": [
        "push.example.com",
        "push2.example.com"
    ],
    "ISPList": [
        "telecom"
    ],
    "UserRegionList": [
        {
            "Area": "CN",
            "Country": "CN",
            "Province": "beijing"
        }
    ],
    "StartTime": "2021-04-13T00:00:00+08:00",
    "EndTime": "2021-04-14T00:00:00+08:00",
    "Aggregation": 300,
    "DetailField": [
        "Domain"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeLiveSourceTrafficData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainList": [
            "push.example.com",
            "push2.example.com"
        ],
        "Domain": "push.example.com",
        "App": "live",
        "Stream": "example_stream",
        "ISPList": [
            "telecom"
        ],
        "UserRegionList": [
            {
                "Area": "CN",
                "Country": "CN",
                "Province": "beijing"
            }
        ],
        "DetailField": [
            "Domain"
        ],
        "StartTime": "2021-04-13T00:00:00+08:00",
        "EndTime": "2021-04-14T00:00:00+08:00",
        "Aggregation": 300,
        "TotalTraffic": 20,
        "TrafficDataList": [
            {
                "TimeStamp": "2022-04-13T00:00:00+08:00",
                "Traffic": 20,
                "Bandwidth": 10
            }
        ],
        "TrafficDetailDataList": [
            {
                "Domain": "push.example.com",
                "ISP": "telecom",
                "TotalTraffic": 20,
                "TrafficDataList": [
                    {
                        "TimeStamp": "2022-04-13T00:00:00+08:00",
                        "Traffic": 20,
                        "Bandwidth": 10
                    }
                ],
                "PeakBandwidth": 10
            }
        ],
        "PeakBandwidth": 10
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。