带宽和流量查询--慢直播-火山引擎

文档中心

立即注册

导航

带宽和流量查询

最近更新时间：2022.09.26 17:04:22首次发布时间：2022.08.19 18:13:10

查询指定空间在指定时间段的带宽和流量信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetDataProjectWithBindWidthAndFlow
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取
Data	Query	String	是	查询的数据类型	可选枚举值包括： BindWidth（带宽数量） Flow（流量数据）
StreamName	Query	String	是	筛选条件，视频流名称（如指定，则查询视频流维度的带宽和流量数据；如不指定，需传入空值）	可通过调用 ListStreams 接口获取
StartTime	Query	String	是	查询起始时间	单位：秒；格式示例：1658486583
EndTime	Query	String	是	查询结束时间	单位：秒；格式示例：1659091383

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
TotalUp	Float	上行接入带宽峰值/流量总量
TotalDown	Float	下行播放带宽峰值/流量总量
DataUp	Array of objects	上行接入带宽/流量数据详情，参考以下带宽/流量数据结构
DataDown	Array of objects	下行播放带宽/流量数据详情，参考以下带宽/流量数据结构

带宽/流量数据结构说明

字段	类型	说明
TimeStamp	String	时间戳
Value	Float	带宽/流量值：当查询时间间隔小于1天，则返回值为5分钟一个点当查询时间间隔大于1天且小于1个月，则返回值为1小时一个点当查询时间间隔大于1个月，则返回值为1天一个点

字段

类型

说明

TimeStamp

String

时间戳

Value

Float

带宽/流量值：

当查询时间间隔小于1天，则返回值为5分钟一个点
当查询时间间隔大于1天且小于1个月，则返回值为1小时一个点
当查询时间间隔大于1个月，则返回值为1天一个点

示例

请求示例

GET https://open.volcengineapi.com?Action=GetDataProjectWithBindWidthAndFlow
&Version=2021-01-01
&SpaceID=517ff7ec-7700-4862-b1e7-7967a4xxxxxx
&Data=Flow
&StreamName=34020083991320xxxxxx_34020083991320xxxxxx
&StartTime=1664090830
&EndTime=1664091810
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022092612492801013303401322341A4E",
        "Action": "GetDataProjectWithBindWidthAndFlow",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalUp": 3436930072,
        "TotalDown": 3439132368,
        "DataUp": [
            {
                "TimeStamp": "2022-09-25T15:25:00+08:00",
                "Value": 0
            },
            {
                "TimeStamp": "2022-09-25T15:30:00+08:00",
                "Value": 1145651224
            },
            {
                "TimeStamp": "2022-09-25T15:35:00+08:00",
                "Value": 1143015576
            },
            {
                "TimeStamp": "2022-09-25T15:40:00+08:00",
                "Value": 1148263272
            }
        ],
        "DataDown": [
            {
                "TimeStamp": "2022-09-25T15:25:00+08:00",
                "Value": 0
            },
            {
                "TimeStamp": "2022-09-25T15:30:00+08:00",
                "Value": 1147380048
            },
            {
                "TimeStamp": "2022-09-25T15:35:00+08:00",
                "Value": 1143568280
            },
            {
                "TimeStamp": "2022-09-25T15:40:00+08:00",
                "Value": 1148184040
            }
        ]
    }
}