调用 DescribeLiveMetricTrafficData
接口,查询指定时间范围内直播域名或直播流的流量监控数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveMetricTrafficData | 接口名称。当前 API 的名称为 DescribeLiveMetricTrafficData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["push.example.com"] | 域名列表,默认为空,表示查询您视频直播产品下所有域名的流量监控数据。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,获取待查询的域名。 |
App | String | 否 |
| 应用名称,取值与直播流地址中的 AppName 字段取值相同,查询流粒度数据时必传,且需同时传入 说明 查询流粒度的流量监控数据时,需同时指定 |
Stream | String | 否 |
| 流名称,取值与直播流地址中的 StreamName 字段取值相同,查询流粒度数据时必传,且需同时传入 说明 查询流粒度的流量监控数据时,需同时指定 |
ProtocolList | Array of String | 否 |
| 推拉流协议,缺省情况下表示所有协议类型,支持的协议如下所示。
说明 如果查询推拉流协议为 |
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 格式的时间戳,精度为秒。 |
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 | ["push.example.com"] | 域名列表。 |
App | String | live | 查询流粒度数据时的应用名称。 |
Stream | String | example_stream | 查询流粒度数据时的流名称。 |
ProtocolList | Array of String |
| 推拉流协议,协议说明如下。
|
ISPList | Array of String |
| 提供网络接入服务的运营商标识符,标识符与运营商的对应关系如下。
|
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 |
| 聚合的时间粒度,单位为秒。
|
DetailField | Array of String |
| 数据拆分的维度,维度说明如下所示。
|
TotalUpTraffic | Float | 20 | 查询时间范围内的上行总流量,单位为 GB。 |
TotalDownTraffic | Float | 20 | 查询时间范围内的下行总流量,单位为 GB。 |
TrafficDataList | Array of TrafficData | - | 所有时间粒度的数据。 |
TrafficDetailDataList | Array of TrafficDetailData |
| 按维度拆分后的数据。 说明 配置数据拆分维度时,对应的维度参数传入多个值时会返回按维度进行拆分的数据;对应的维度只传入一个值时不返回按此维度进行拆分的数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Area | String | CN | 区域信息中的大区标识符。 |
Country | String | CN | 区域信息中的国家标识符。 |
Province | String | beijing | 区域信息中的省份标识符。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2022-04-13T00:00:00+08:00 | 数据按时间粒度聚合时,每个时间粒度的开始时间,RFC3339 格式的时间戳,精度为秒。 |
UpTraffic | Float | 20 | 当前数据聚合时间粒度内产生的总上行流量,单位 GB。 |
DownTraffic | Float | 20 | 当前数据聚合时间粒度内产生的总下行流量,单位 GB。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | push.example.com | 按域名维度进行数据拆分时的域名信息。 |
Protocol | String | HTTP-FLV | 按推拉流协议维度进行数据拆分时的协议信息。 |
ISP | String | telecom | 按运营商维度进行数据拆分时的运营商信息。 |
TotalUpTraffic | Float | 20 | 按维度进行数据拆分后,当前维度的上行总流量,单位为 GB。 |
TotalDownTraffic | Float | 20 | 按维度进行数据拆分后,当前维度的下行总流量,单位为 GB。 |
TrafficDataList | Array of TrafficData | - | 按维度进行数据拆分后,当前维度下所有时间粒度的数据。 |
POST https://live.volcengineapi.com?Action=DescribeLiveMetricTrafficData&Version=2023-01-01 { "DomainList": [ "push.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": "DescribeLiveMetricTrafficData", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "DomainList": [ "puhs.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, "TotalUpTraffic": 20, "TotalDownTraffic": 20, "TrafficDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpTraffic": 20, "DownTraffic": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpTraffic": 20, "DownTraffic": 20 } ], "TrafficDetailDataList": [ { "Protocol": "HTTP-FLV", "TotalUpTraffic": 20, "TotalDownTraffic": 20, "TrafficDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpTraffic": 20, "DownTraffic": 20 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpTraffic": 20, "DownTraffic": 20 } ] }, { "Protocol": "RTMP", "TotalUpTraffic": 0, "TotalDownTraffic": 0, "TrafficDataList": [ { "TimeStamp": "2022-04-13T00:00:00+08:00", "UpTraffic": 0, "DownTraffic": 0 }, { "TimeStamp": "2022-04-13T00:05:00+08:00", "UpTraffic": 0, "DownTraffic": 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。