DescribeLiveActivityBandwidthData - 查询活动带宽用量--视频直播-火山引擎

文档中心

立即注册

导航

DescribeLiveActivityBandwidthData - 查询活动带宽用量

最近更新时间：2025.04.22 19:10:55首次发布时间：2023.12.05 11:57:44

调用 DescribeLiveActivityBandwidthData 接口，查询活动带宽的带宽用量。

注意事项

计费说明：活动带宽计费价格请参见活动带宽计费。
使用限制：支持查询指定域名（包含已删除域名）的活动带宽用量，即在活动护航时拉流域名的下行峰值带宽。
请求频率：单用户请求频率限制为 30 次/秒。
数据延迟：数据延迟为 15 分钟。
数据进制：带宽数据统计进制为 1000，例如，1 Mbps = 1000 Kbps。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
DomainList	Array of String	否	`["pull.example.com"]`	域名列表，默认为空，表示查询您视频直播产品下所有域名的带宽用量数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的域名。
ProtocolList	Array of String	否	`["HTTP-FLV", "RTMP"]`	推拉流协议，缺省情况下表示所有协议类型，支持的协议如下所示。 `HTTP-FLV`：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 `HTTP-HLS`：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 `RTMP`：Real Time Message Protocol，实时信息传输协议。 `RTM`：Real Time Media，超低延时直播协议。 `SRT`：Secure Reliable Transport，安全可靠传输协议。 `QUIC`：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。说明如果查询推拉流协议为 `QUIC`，不能同时查询其他协议。
ISPList	Array of String	否	`["telecom", "unicom"]`	提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。
RegionList	Array of Region	否	`-`	CDN 节点 IP 所属区域的列表，缺省情况下表示所有区域。说明参数 `RegionList`和`UserRegionList` 不支持同时传入。
UserRegionList	Array of Region	否	`-`	客户端 IP 所属区域的列表，缺省情况下表示所有区域。说明参数 `RegionList`和`UserRegionList` 不支持同时传入。
StartTime	String	是	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	是	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	否	`300`	数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。 `300`：（默认值）5 分钟。时间粒度为 5 分钟时，单次查询最大时间跨度为 31 天，历史查询时间范围为 366 天； `3600`：1 小时。时间粒度为 1 小时时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天； `86400`：1 天。时间粒度为 1 天时，单次查询最大时间跨度为 93 天，历史查询时间范围为 366 天。

Region

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

返回参数

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

参数	类型	示例值	描述
DomainList	Array of String	`["pull.example.com"]`	域名列表。
ProtocolList	Array of String	`["HTTP-FLV", "RTMP"]`	推拉流协议，协议说明如下。 `HTTP-FLV`：基于 HTTP 协议的推拉流协议，使用 FLV 格式传输视频格式。 `HTTP-HLS`：基于 HTTP 协议的推拉流协议，使用 TS 格式传输视频格式。 `RTMP`：Real Time Message Protocol，实时信息传输协议。 `RTM`：Real Time Media，超低延时直播协议。 `SRT`：Secure Reliable Transport，安全可靠传输协议。 `QUIC`：Quick UDP Internet Connections，一种基于 UDP 的全新的低延时互联网传输协议。
ISPList	Array of String	`["telecom"]`	提供网络接入服务的运营商标识符，标识符与运营商的对应关系如下。 `unicom`：联通； `railcom`：铁通； `telecom`：电信； `mobile`：移动； `cernet`：教育网； `tianwei`：天威； `alibaba`：阿里巴巴； `tencent`：腾讯； `drpeng`：鹏博士； `btvn`：广电； `huashu`：华数。
RegionList	Array of RegionResponse	`-`	CDN 节点 IP 所属区域列表。
UserRegionList	Array of RegionResponse	`-`	客户端 IP 所属区域列表。
StartTime	String	`2021-04-13T00:00:00+08:00`	查询的开始时间，RFC3339 格式的时间戳，精度为秒。
EndTime	String	`2021-04-14T00:00:00+08:00`	查询的结束时间，RFC3339 格式的时间戳，精度为秒。
Aggregation	Integer	`300`	数据聚合的时间粒度，单位为秒。 `300`：5 分钟； `3600`：1 小时； `86400`：1 天。
PeakBandwidth	Integer	`20`	当前查询条件下的峰值带宽，单位为 Mbps。
PeakTimestamp	String	`2021-04-13T00:00:00+08:00`	峰值带宽的时间戳，RFC3339 格式的时间戳，精度为秒。
BandwidthDataList	Array of BandwidthDataList	`-`	所有时间粒度的数据。

RegionResponse

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

BandwidthDataList

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

请求示例

POST https://live.volcengineapi.com?Action=DescribeLiveActivityBandwidthData&Version=2023-01-01
{
    "DomainList": [
        "pull.example.com"
    ],
    "ProtocolList": [
        "HTTP-FLV",
        "RTMP"
    ],
    "ISPList": [
        "telecom"
    ],
    "RegionList": [
        {
            "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": [
        "Protocol"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeLiveBandwidthData",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "DomainList": [
            "pull.example.com"
        ],
        "ProtocolList": [
            "HTTP-FLV",
            "RTMP"
        ],
        "ISPList": [
            "telecom"
        ],
        "RegionList": [
            {
                "Area": "CN",
                "Country": "CN",
                "Province": "beijing"
            }
        ],
        "StartTime": "2021-04-13T00:00:00+08:00",
        "EndTime": "2021-04-14T00:00:00+08:00",
        "Aggregation": 300,
        "PeakBandwidth": 20,
        "PeakTimestamp": "2022-04-13T00:00:00+08:00",
        "BandwidthDataList": [
            {
                "TimeStamp": "2022-04-13T00:00:00+08:00",
                "Bandwidth": 20
            },
            {
                "TimeStamp": "2022-04-13T00:05:00+08:00",
                "Bandwidth": 20
            }
        ]
    }
}

错误码

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

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