调用 DescribeLiveEdgeStatData
接口,查询指定协议、运营商、区域、时间范围下,直播流产生的上下行流量、上下行峰值带宽和请求数等数据。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveEdgeStatData | 接口名称。当前 API 的名称为 DescribeLiveEdgeStatData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["push.example.com","pull.example.com"] | 域名列表,默认为空,表示您添加到视频直播中的所有域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,获取待查询的域名。 |
AppList | Array of String | 否 | ["live","vodlive"] | 直播流地址中的 AppName 字段列表,默认为空表示所有 AppName。每个 AppName 支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 |
StreamList | Array of String | 否 | ["stream001","stream002"] | 直播流地址中的 StreamName 字段列表,默认为空表示所有 StreamName。每个 StreamName 支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。 |
ProtocolList | Array of String | 否 |
| 推拉流协议,缺省情况下表示所有协议类型,支持的协议如下所示。
说明 如果查询推拉流协议为 |
ISPList | Array of String | 否 |
| 提供网络接入服务的运营商标识符,缺省情况下表示所有运营商,支持的运营商如下所示。
|
RegionList | Array of Region | 否 |
| CDN 节点 IP 所属区域的列表,缺省情况下表示所有区域。 说明 参数 |
UserRegionList | Array of Region | 否 |
| 客户端 IP 所属区域的列表,缺省情况下表示所有区域。 说明 参数 |
DetailField | Array of String | 否 |
| 数据拆分的维度,缺省情况下不进行数据拆分,支持的维度如下所示。
|
Aggregation | Integer | 否 |
| 数据聚合的时间粒度,单位为秒,支持以下取值。
|
StartTime | String | 是 | 2024-12-12T00:00:00+08:00 | 查询的开始时间,RFC3339 格式的时间戳,精度为秒。 |
EndTime | String | 是 |
| 查询的结束时间,RFC3339 格式的时间戳,精度为秒。 说明 历史查询最大时间范围为 366 天,单次查询最大时间跨度与数据拆分维度和数据聚合时间粒度有关,详细如下。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Area | String | 否 | CN | 区域信息中的大区标识符,如何获取请参见查询区域标识符。 |
Country | String | 否 | CN | 区域信息中的国家标识符,如何获取请参见查询区域标识符。如果按国家筛选,需要同时传入 Area 和 Country 。 |
Province | String | 否 | beijing | 区域信息中的省份标识符,国外暂不支持该参数,如何获取请参见查询区域标识符。如果按省筛选,需要同时传入 Area 、Country 和 Province 。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["push.example.com","pull.example.com"] | 域名列表。 |
AppList | Array of String | ["live","livevod"] | AppName 列表。 |
StreamList | Array of String | ["stream001","stream002"] | StreamName 列表。 |
ProtocolList | Array of String |
| 推拉流协议,协议说明如下。
|
ISPList | Array of String |
| 提供网络接入服务的运营商标识符,标识符与运营商的对应关系如下。
|
RegionList | Array of Region | - | CDN 节点 IP 所属区域列表。 |
UserRegionList | Array of Region | - | 客户端 IP 所属区域列表。 |
DetailField | Array of String |
| 数据拆分的维度,维度说明如下所示。
|
Aggregation | Integer | 300 | 数据聚合的时间粒度,单位为秒。 |
StartTime | String | 2024-12-12T00:00:00+08:00 | 查询的开始时间,RFC3339 格式的时间戳,精度为秒。 |
EndTime | String | 2024-12-12T01:00:00+08:00 | 查询的结束时间,RFC3339 格式的时间戳,精度为秒。 |
PeakUpBandwidth | Float | 10 | 上行带宽峰值,单位为 Mbps。 |
PeakDownBandwidth | Float | 10 | 下行峰值带宽,单位为 Mbps。 |
TotalUpTraffic | Float | 20 | 上行总流量,单位为 GB。 |
TotalDownTraffic | Float | 20 | 下行总流量,单位为 GB。 |
TotalRequest | Float | 5 | 请求数。 |
EdgeStatDataList | Array of EdgeStatDataList | - | 所有时间粒度的数据。 |
EdgeStatDetailDataList | Array of EdgeStatDetailDataList | - | 按维度拆分后的数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Area | String | CN | 区域信息中的大区标识符。 |
Country | String | CN | 区域信息中的国家标识符。 |
Province | String | beijing | 区域信息中的省份标识符。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2024-12-12T00:00:00+08:00 | 数据按时间粒度聚合时,每个时间粒度的开始时间,RFC3339 格式的 UTC+8 时间,精度为秒。 |
UpTraffic | Float | 20 | 当前数据聚合时间粒度内产生的总上行流量,单位 GB。 |
DownTraffic | Float | 20 | 当前数据聚合时间粒度内产生的总下行流量,单位 GB。 |
UpBandwidth | Float | 10 | 上行峰值带宽。 |
DownBandwidth | Float | 10 | 下行峰值带宽。 |
Request | Float | 5 | 请求参数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domain | String | push。example.com | 按域名维度进行数据拆分时的域名信息。 |
Protocol | String | HTTP-FLV | 按推拉流协议维度进行数据拆分时的协议信息。 |
ISP | String | telecom | 按运营商维度进行数据拆分时的运营商信息。 |
PeakUpBandwidth | Float | 10 | 按维度进行数据拆分后,当前维度的上行峰值带宽,单位为 Mbps。 |
PeakDownBandwidth | Float | 10 | 按维度进行数据拆分后,当前维度的下行峰值带宽,单位为 Mbps。 |
TotalUpTraffic | Float | 20 | 按维度进行数据拆分后,当前维度的上行总流量,单位为 GB。 |
TotalDownTraffic | Float | 20 | 按维度进行数据拆分后,当前维度的下行总流量,单位为 GB。 |
TotalRequest | Float | 5 | 按维度进行数据拆分后,当前维度的请求数。 |
EdgeStatDataList | Array of EdgeStatDataList | - | 按维度进行数据拆分后,当前维度下所有时间粒度的数据。 |
POST https://live.volcengineapi.com?Action=DescribeLiveEdgeStatData&Version=2023-01-01 { "DomainList": [ "push.example.com", "pull.example.com" ], "ProtocolList": [ "HTTP-FLV", "RTMP" ], "ISPList": [ "unicom", "telecom" ], "RegionList": [ { "Area": "CN", "Country": "CN", "Province": "beijing" } ], "StartTime": "2024-12-12T00:00:00+08:00", "EndTime": "2024-12-12T01:00:00+08:00", "Aggregation": 300, "DetailField": [ "Domain" ], "AppList": [ "live" ], "StreamList": [ "stream001", "stream002" ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DescribeLiveEdgeStatData", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "DomainList": [ "push.example.com", "pull.example.com" ], "ProtocolList": [ "HTTP-FLV", "RTMP" ], "ISPList": [ "" ], "RegionList": [ { "Area": "CN", "Country": "CN", "Province": "beijing" } ] ], "StartTime": "2024-12-12T00:00:00+08:00", "EndTime": "2024-12-12T01:00:00+08:00", "Aggregation": 300, "DetailField": [ "" ], "TotalUpTraffic": 20, "TotalDownTraffic": 20, "AppList": [ "live", "livevod" ], "StreamList": [ "stream001", "stream002" ], "PeakUpBandwidth": 10, "PeakDownBandwidth": 10, "TotalRequest": 5, "EdgeStatDataList": [ { "TimeStamp": "2024-12-12T00:00:00+08:00", "UpTraffic": 20, "DownTraffic": 20, "UpBandwidth": 10, "DownBandwidth": 10, "Request": 5 } ], "EdgeStatDetailDataList": [ { "Protocol": "HTTP-FLV", "Domain": "push。example.com", "ISP": "telecom", "TotalUpTraffic": 20, "TotalDownTraffic": 20, "PeakUpBandwidth": 10, "PeakDownBandwidth": 10, "TotalRequest": 5, "EdgeStatDataList": [ { "TimeStamp": "2024-12-12T00:00:00+08:00", "UpTraffic": 20, "DownTraffic": 20, "UpBandwidth": 10, "DownBandwidth": 10, "Request": 5 } ] } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 内部服务超时,请联系技术支持。 |