最近更新时间：2023.12.05 11:57:53
首次发布时间：2023.09.25 14:35:35
查询直播上行、下行（含时移分发）带宽数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeLiveBandwidthData | 接口名称。当前 API 的名称为 DescribeLiveBandwidthData。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| DomainList | Array of String | 否 | ["example.com"] | 域名列表，缺省情况表示该用户的所有域名。 |
ProtocolList | Array of String | 否 |
| 推拉流协议，缺省情况下表示所有协议类型。支持的协议如下所示。
说明 如果设置推拉流协议为 QUIC，不能同时传其他协议。 |
ISPList | Array of String | 否 |
| 运营商，缺省情况下表示所有运营商。支持的运营商如下所示。
|
| RegionList | Array of Region | 否 | - | CDN 节点 IP 所属区域的列表。缺省情况下表示所有区域。 |
| UserRegionList | Array of Region | 否 | - | 客户端 IP 所属区域的列表，缺省情况下表示所有区域。 |
| StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间，RFC3339 格式的 UTC 时间，精度为 s。 |
| EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间，RFC3339 格式的 UTC 时间，精度为 s。 |
Aggregation | Integer | 否 |
| 时间粒度，单位为 s，默认值为 300。支持如下时间粒度。
|
| DetailField | Array of String | 否 | ["Domain"] | 数据拆分的维度，可取值为 "Domain"，"ISP"，"Protocol"，设置为空时不进行数据拆分。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Area | String | 否 | CN | 大区标识符，如何获取请参见查询区域标识符。 |
| Country | String | 否 | CN | 国家标识符，如何获取请参见查询区域标识符。如果按国家筛选，需要同时传入 Area 和 Country。 |
| Province | String | 否 | beijing | 省份标识符，国外暂不支持该参数，如何获取请参见查询区域标识符。如果按省筛选，需要同时传入 Area、Country 和 Province。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| DomainList | Array of String | ["example.com"] | 域名列表，代表所查询的域名。 |
| ProtocolList | Array of String | ["HTTP-FLV", "RTMP"] | 推拉流协议。 |
| ISPList | Array of String | ["telecom"] | 运营商。 |
| RegionList | Array of RegionResponse | - | CDN 节点 IP 所属区域。 |
| UserRegionList | Array of RegionResponse | - | 客户端 IP 所属区域。 |
| StartTime | String | 2021-04-13T00:00:00+08:00 | 开始时间。 |
| EndTime | String | 2021-04-14T00:00:00+08:00 | 结束时间。 |
| Aggregation | Integer | 300 | 时间粒度。 |
| DetailField | Array of String | ["Domain"] | 数据拆分的维度。 |
| PeakUpBandwidth | Float | 20 | 上行峰值，单位为 Mbps。 |
| PeakDownBandwidth | Float | 20 | 下行峰值，单位为 Mbps。 |
| BandwidthDataList | Array of BandwidthData | - | 所有时间粒度数据。 |
BandwidthDetailDataList | Array of BandwidthDetailData |
| 按维度拆分的数据。 说明 请求时， |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Area | String | CN | 大区标识符。 |
| Country | String | CN | 国家标识符。 |
| Province | String | beijing | 省份标识符。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TimeStamp | String | 2022-04-13T00:00:00+08:00 | 时间片起始时刻。RFC3339 格式的 UTC 时间，精度为 s。 |
| UpBandwidth | Float | 20 | 上行带宽，单位为 Mbps。 |
| DownBandwidth | Float | 20 | 下行带宽，单位为 Mbps。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Domain | String | example.com | 域名。 |
| Protocol | String | RTMP | 推拉流协议。 |
| ISP | String | telecom | 运营商。 |
| PeakUpBandwidth | Float | 20 | 上行峰值，单位为 Mbps。 |
| PeakDownBandwidth | Float | 20 | 下行峰值，单位为 Mbps。 |
| BandwidthDataList | Array of BandwidthData | - | 带宽用量数据。 |
POST https://live.volcengineapi.com?Action=DescribeLiveBandwidthData&Version=2023-01-01 { "DomainList": [ "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": [ "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, "PeakUpBandwidth": 20, "PeakDownBandwidth": 20, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 } ], "BandwidthDetailDataList": [ { "Protocol": "HTTP-FLV", "PeakUpBandwidth": 20, "PeakDownBandwidth": 20, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpBandwidth": 20, "DownBandwidth": 20 } ] }, { "Protocol": "RTMP", "PeakUpBandwidth": 0, "PeakDownBandwidth": 0, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpBandwidth": 0, "DownBandwidth": 0 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpBandwidth": 0, "DownBandwidth": 0 } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误，请联系技术支持。 |
| 500 | InternalError.ServicesOrBilling | an internal error related to service or billing occurred, please contact the administrator. | 出现与服务或账单相关的内部错误，请联系技术支持。 |
| 502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误，请联系技术支持。 |
| 504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时，请联系技术支持。 |