You need to enable JavaScript to run this app.
导航
DescribeLiveEdgeStatData - 查询边缘数据
最近更新时间:2024.12.18 16:31:43首次发布时间:2024.12.18 16:31:43

调用 DescribeLiveEdgeStatData 接口,查询指定协议、运营商、区域、时间范围下,直播流产生的上下行流量、上下行峰值带宽和请求数等数据。

注意事项

  • 使用限制:
    • 边缘数据中的流量数据用于数据监控,其采集方式不同于流量用量数据,请使用 DescribeLiveTrafficData 查询直播流量用量数据。
    • 边缘数据中的带宽数据用于数据监控,其采集方式不同于带宽用量数据,请使用 DescribeLiveBandwidthData 查询直播带宽用量数据。
  • 请求频率:单用户请求频率限制为 30 次/秒
  • 数据延迟:时间粒度为 60 秒时,数据延迟为 5 分钟;其他时间粒度时,数据延迟为 15 分钟
  • 数据进制:
    • 流量数据统计进制为 1000,例如,1 GB = 1000 MB。
    • 带宽数据统计进制为 1000,例如,1 Mbps = 1000 Kbps。

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeLiveEdgeStatData接口名称。当前 API 的名称为 DescribeLiveEdgeStatData
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
DomainListArray of String["push.example.com","pull.example.com"]域名列表,默认为空,表示您添加到视频直播中的所有域名。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,获取待查询的域名。
AppListArray of String["live","vodlive"]直播流地址中的 AppName 字段列表,默认为空表示所有 AppName。每个 AppName 支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。
StreamListArray of String["stream001","stream002"]直播流地址中的 StreamName 字段列表,默认为空表示所有 StreamName。每个 StreamName 支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 100 个字符。

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

["unicom", "telecom"]

提供网络接入服务的运营商标识符,缺省情况下表示所有运营商,支持的运营商如下所示。

  • unicom:联通;
  • railcom:铁通;
  • telecom:电信;
  • mobile:移动;
  • cernet:教育网;
  • tianwei:天威;
  • alibaba:阿里巴巴;
  • tencent:腾讯;
  • drpeng:鹏博士;
  • btvn:广电;
  • huashu:华数。
    您也可以通过 DescribeLiveISPData 接口获取运营商对应的标识符。

RegionList

Array of Region

-

CDN 节点 IP 所属区域的列表,缺省情况下表示所有区域。

说明

参数 RegionListUserRegionList 不支持同时传入。

UserRegionList

Array of Region

-

客户端 IP 所属区域的列表,缺省情况下表示所有区域。

说明

参数 RegionListUserRegionList 不支持同时传入。

DetailField

Array of String

["Domain"]

数据拆分的维度,缺省情况下不进行数据拆分,支持的维度如下所示。

  • Domain:域名;
  • Protocol:推拉流协议;
  • ISP:运营商。

Aggregation

Integer

300

数据聚合的时间粒度,单位为秒,支持以下取值。

  • 60:1 分钟。
  • 300:(默认值)5 分钟。
  • 3600:1 小时。
StartTimeString2024-12-12T00:00:00+08:00查询的开始时间,RFC3339 格式的时间戳,精度为秒。

EndTime

String

2024-12-12T01:00:00+08:00

查询的结束时间,RFC3339 格式的时间戳,精度为秒。

说明

历史查询最大时间范围为 366 天,单次查询最大时间跨度与数据拆分维度和数据聚合时间粒度有关,详细如下。

  • 当不进行维度拆分或只使用一个维度拆分数据时:
    • 数据以 60 秒聚合时,单次查询最大时间跨度为 24 小时;
    • 数据以 300 秒聚合时,单次查询最大时间跨度为 31 天;
    • 数据以 3600 秒聚合时,单次查询最大时间跨度为 31 天。
  • 当使用两个或两个以上维度拆分数据时:
    • 数据以 60 秒聚合时,单次查询最大时间跨度为 3 小时;
    • 数据以 300 秒聚合时,单次查询最大时间跨度为 24 小时;
    • 数据以 3600 秒聚合时,单次查询最大时间跨度为 7 天。

Region

参数类型是否必选示例值描述
AreaStringCN区域信息中的大区标识符,如何获取请参见查询区域标识符
CountryStringCN区域信息中的国家标识符,如何获取请参见查询区域标识符。如果按国家筛选,需要同时传入 AreaCountry
ProvinceStringbeijing区域信息中的省份标识符,国外暂不支持该参数,如何获取请参见查询区域标识符。如果按省筛选,需要同时传入 AreaCountryProvince

返回参数

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

参数类型示例值描述
DomainListArray of String["push.example.com","pull.example.com"]域名列表。
AppListArray of String["live","livevod"]AppName 列表。
StreamListArray of String["stream001","stream002"]StreamName 列表。

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

["unicom",telecom"]

提供网络接入服务的运营商标识符,标识符与运营商的对应关系如下。

  • unicom:联通;
  • railcom:铁通;
  • telecom:电信;
  • mobile:移动;
  • cernet:教育网;
  • tianwei:天威;
  • alibaba:阿里巴巴;
  • tencent:腾讯;
  • drpeng:鹏博士;
  • btvn:广电;
  • huashu:华数。
RegionListArray of Region-CDN 节点 IP 所属区域列表。
UserRegionListArray of Region-客户端 IP 所属区域列表。

DetailField

Array of String

[Domain]

数据拆分的维度,维度说明如下所示。

  • Domain:域名;
  • Protocol:推拉流协议;
  • ISP:运营商。
AggregationInteger300数据聚合的时间粒度,单位为秒。
StartTimeString2024-12-12T00:00:00+08:00查询的开始时间,RFC3339 格式的时间戳,精度为秒。
EndTimeString2024-12-12T01:00:00+08:00查询的结束时间,RFC3339 格式的时间戳,精度为秒。
PeakUpBandwidthFloat10上行带宽峰值,单位为 Mbps。
PeakDownBandwidthFloat10下行峰值带宽,单位为 Mbps。
TotalUpTrafficFloat20上行总流量,单位为 GB。
TotalDownTrafficFloat20下行总流量,单位为 GB。
TotalRequestFloat5请求数。
EdgeStatDataListArray of EdgeStatDataList-所有时间粒度的数据。
EdgeStatDetailDataListArray of EdgeStatDetailDataList-按维度拆分后的数据。

Region

参数类型示例值描述
AreaStringCN区域信息中的大区标识符。
CountryStringCN区域信息中的国家标识符。
ProvinceStringbeijing区域信息中的省份标识符。

EdgeStatDataList

参数类型示例值描述
TimeStampString2024-12-12T00:00:00+08:00数据按时间粒度聚合时,每个时间粒度的开始时间,RFC3339 格式的 UTC+8 时间,精度为秒。
UpTrafficFloat20当前数据聚合时间粒度内产生的总上行流量,单位 GB。
DownTrafficFloat20当前数据聚合时间粒度内产生的总下行流量,单位 GB。
UpBandwidthFloat10上行峰值带宽。
DownBandwidthFloat10下行峰值带宽。
RequestFloat5请求参数。

EdgeStatDetailDataList

参数类型示例值描述
DomainStringpush。example.com按域名维度进行数据拆分时的域名信息。
ProtocolStringHTTP-FLV按推拉流协议维度进行数据拆分时的协议信息。
ISPStringtelecom按运营商维度进行数据拆分时的运营商信息。
PeakUpBandwidthFloat10按维度进行数据拆分后,当前维度的上行峰值带宽,单位为 Mbps。
PeakDownBandwidthFloat10按维度进行数据拆分后,当前维度的下行峰值带宽,单位为 Mbps。
TotalUpTrafficFloat20按维度进行数据拆分后,当前维度的上行总流量,单位为 GB。
TotalDownTrafficFloat20按维度进行数据拆分后,当前维度的下行总流量,单位为 GB。
TotalRequestFloat5按维度进行数据拆分后,当前维度的请求数。
EdgeStatDataListArray 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
                    }
                ]
            }
        ]
    }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
403RequestForbidden-请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。
404ResourceNotFound-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
500InternalErroran internal error occurred, please contact the administrator.出现内部错误,请联系技术支持
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误,请联系技术支持
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时,请联系技术支持