调用 DescribeLiveSourceBandwidthData 接口，查询指定时间范围内拉流域名或回源流产生的回源带宽监控数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeLiveSourceBandwidthData | 接口名称。当前 API 的名称为 DescribeLiveSourceBandwidthData。 |
| Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
DomainList | Array of String | 否 |
| 拉流域名列表，默认为空，表示查询所有域名的回源带宽监控数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。 说明
|
Domain | String | 否 |
| 拉流域名，您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，获取待查询的拉流域名。 说明 查询流粒度的回源带宽监控数据时，需同时指定 |
App | String | 否 |
| 应用名称，取值需与直播流地址中 说明 查询流粒度的回源流量监控数据时，需同时指定 |
Stream | String | 否 |
| 流名称，取值需与直播流地址中的 说明 查询流粒度的请求数和在线人数数据时，需同时指定 |
ISPList | Array of String | 否 |
| 提供网络接入服务的运营商标识符，缺省情况下表示所有运营商，支持的运营商如下所示。
您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。 |
| UserRegionList | Array of Region | 否 | - | 客户端 IP 所属区域的列表，缺省情况下表示所有区域。 |
| StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的开始时间，RFC3339 格式的时间戳，精度为秒。 |
| EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间，RFC3339 格式的时间戳，精度为秒。 |
Aggregation | Integer | 否 |
| 数据聚合的时间粒度，单位为秒，支持的时间粒度如下所示。
|
DetailField | Array of String | 否 |
| 数据拆分的维度，默认为空表示不按维度进行数据拆分，支持的维度如下所示。
说明 配置数据拆分的维度时，对应的维度参数传入多个值时才会返回按此维度拆分的数据。例如，配置按 Domain 进行数据拆分时， DomainList 传入多个 Domain 值时，才会返回按 Domain 拆分的数据。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Area | String | 否 | CN | 区域信息中的大区标识符，如何获取请参见查询区域标识符。 |
| Country | String | 否 | CN | 区域信息中的国家标识符，如何获取请参见查询区域标识符。如果按国家筛选，需要同时传入 Area 和 Country。 |
| Province | String | 否 | beijing | 区域信息中的省份标识符，国外暂不支持该参数，如何获取请参见查询区域标识符。如果按省筛选，需要同时传入 Area、Country 和 Province。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| DomainList | Array of String | ["pull.example.com", "pull2.example.com"] | 域名列表。 |
| Domain | String | pull.example.com | 查询流粒度数据时的域名。 |
| App | String | live | 查询流粒度数据时的应用名称。 |
| Stream | String | example_stream | 查询流粒度数据时的流名称。 |
ISPList | Array of String |
| 提供网络接入服务的运营商标识符，标识符与运营商的对应关系如下。
|
| UserRegionList | Array of Region | - | 客户端 IP 所属区域列表。 |
DetailField | Array of String |
| 数据拆分的维度，维度说明如下所示。
|
| StartTime | String | 2021-04-13T00:00:00+08:00 | 查询的开始时间，RFC3339 格式的时间戳，精度为秒。 |
| EndTime | String | 2021-04-14T00:00:00+08:00 | 查询的结束时间，RFC3339 格式的时间戳，精度为秒。 |
| Aggregation | Integer | 300 | 数据聚合的时间粒度，单位为秒。 |
| PeakBandwidth | Float | 20 | 查询时间范围内的回源峰值带宽，单位为 Mbps。 |
| BandwidthDataList | Array of BandwidthDataList | - | 所有时间粒度的数据。 |
| BandwidthDetailDataList | Array of BandwidthDetailDataList | - | 按维度拆分后的数据。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Area | String | CN | 区域信息中的大区标识符。 |
| Country | String | CN | 区域信息中的国家标识符。 |
| Province | String | beijing | 区域信息中的省份标识符。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TimeStamp | String | 2022-04-13T00:00:00+08:00 | 数据按时间粒度聚合时，每个时间粒度的开始时间，RFC3339 格式的时间戳，精度为秒。 |
| Bandwidth | Float | 20 | 当前数据聚合时间粒度内的回源峰值带宽，单位为 Mbps。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Domain | String | example.com | 按域名维度进行数据拆分时的域名信息。 |
| ISP | String | telecom | 按运营商维度进行数据拆分时的运营商信息。 |
| PeakBandwidth | Float | 20 | 按维度进行数据拆分后，当前维度的回源峰值带宽，单位为 Mbps。 |
| BandwidthDataList | Array of BandwidthDataList | - | 按维度进行数据拆分后，当前维度下所有时间粒度的数据。 |
POST https://live.volcengineapi.com?Action=DescribeLiveSourceBandwidthData&Version=2023-01-01 { "DomainList": ["pull.example.com", "pull2.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": "201806041104200100100232280022D30", "Action": "DescribeLiveSourceBandwidthData", "Version": "2018-01-01", "Service": "live", "Region": "cn-langfang-1" }, "Result": { "DomainList": [ "pull.example.com", "pull2.example.com" ], "ISPList": [ "telecom" ], "DetailField": [ "Domain" ], "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, "PeakBandwidth": 20, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "Bandwidth": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "Bandwidth": 20 } ], "BandwidthDetailDataList": [ { "Domain": "pull.example.com", "PeakBandwidth": 20, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "Bandwidth": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "Bandwidth": 20 } ] }, { "Domain": "pull2.example.com", "PeakBandwidth": 0, "BandwidthDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "Bandwidth": 0 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "Bandwidth": 0 } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 200 | CommonErr | - | 未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 400 | InvalidParam | - | 输入的参数无效或不符合要求，请参照请求参数说明进行检查。 |
| 400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验，请检查参数类型是否正确。 |
| 403 | RequestForbidden | - | 请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。 |
| 404 | ResourceNotFound | - | 未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。 |
| 500 | InternalError | an internal error 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. | 内部服务超时，请联系技术支持。 |
视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。