全部产品
Search

搜索本产品

    视频直播：DescribeLiveDomainBpsDataByLayer - 按协议分类查询域名带宽及流量数据

    文档中心

    视频直播：DescribeLiveDomainBpsDataByLayer - 按协议分类查询域名带宽及流量数据

    更新时间：Dec 05, 2024

    调用DescribeLiveDomainBpsDataByLayer按协议分类获取域名带宽及流量信息。

    接口说明

    支持数据存储时长 90 天。 支持批量域名查询，多个域名之间用英文逗号（,）分隔，最多支持 500 个域名。多个域名会按照聚合结果输出。 StartTime 和 EndTime 数据间隔跨度不同返回时间粒度也不同，具体如下：

    • 数据间隔≤3 天，返回时间粒度五分钟。

    • 3 天＜数据间隔≤31 天，返回时间粒度 1 小时。

    • 数据间隔＞31 天，返回时间粒度 1 天。

    说明 如果 StartTime 和 EndTime 均未指定数值，默认返回当前时间起 24 小时内数据。

    QPS 限制

    本接口的单用户 QPS 限制为 20 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    live:DescribeLiveDomainBpsDataByLayerget
    *Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DomainNamestring否

    播流域名。支持批量域名查询，多个域名用英文逗号（,）分隔。若参数为空，默认返回所有域名合并后数据。

    		pull.aliyundoc.com
    StartTimestring否

    获取数据起始时间，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    说明 不填默认读取过去 24 小时数据，最小数据粒度为 5 分钟。
    		2022-03-15T16:00:00Z
    EndTimestring否

    结束时间需大于起始时间，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2022-03-16T16:59:59Z
    Intervalstring否

    查询数据的时间粒度，单位：秒（s）。取值：

    • 300

    • 3600

    • 86400

    说明
  • 数据间隔≤3 天，支持数据时间粒度 300、3600、86400。
  • 3 天＜数据间隔≤31 天，支持数据时间粒度 3600 和 86400。
  • 数据间隔＞31 天，支持数据时间粒度 86400。
  • 不传和传的值不支持时，使用默认值 300。
    •
    		300
    IspNameEnstring否

    运营商英文名，不传为所有运营商。

    说明 您可调用 DescribeLiveRegionAndIsp 接口获取区域英文名和运营商英文名。
    		tele***
    LocationNameEnstring否

    区域英文名，不传为所有区域 。

    说明 您可调用 DescribeLiveRegionAndIsp 接口获取区域英文名和运营商英文名。
    		hangzhou
    Layerstring否

    查询维度。可选：

    • 网络层（IPv4、IPv6）

    • 应用层（http、https、quic）

    • all（默认为 all）

    		all

    返回参数

    名称类型描述示例值
    object
    BpsDataIntervalarray<object>

    每个时间间隔的每秒访问次数 Bps。

    DataModuleobject

    每个时间间隔的每秒访问次数 Bps。

    TimeStampstring

    时间片起始时刻。

    		2022-03-15T16:00:00Z
    TrafficValuestring

    总流量，单位：Byte。

    		331
    Valuestring

    峰值带宽，单位：bps。

    		0.56
    DataIntervalstring

    每条数据记录的时间间隔，以秒为单位。

    		300
    RequestIdstring

    请求 ID。

    		BEA5625F-8FCF-48F4-851B-2A48566EA967

    示例

    正常返回示例

    JSON格式

    {
  "BpsDataInterval": {
    "DataModule": [
      {
        "TimeStamp": "2022-03-15T16:00:00Z",
        "TrafficValue": "331",
        "Value": "0.56"
      }
    ]
  },
  "DataInterval": "300",
  "RequestId": "BEA5625F-8FCF-48F4-851B-2A48566EA967"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedSpecified parameter StartTime is not valid.StartTime参数错误，请您确认该StartTime参数是否正确。
    400InvalidEndTime.MalformedSpecified parameter EndTime is not valid.结束时间错误，请您确认结束时间是否正确。
    400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配，请您确认时间的匹配度。
    400InvalidStartTime.ValueNotSupportedSpecified end time does not math the specified start time,And the time range does not exceed 90 days.开始时间与结束时间不匹配，开始时间不能晚于结束时间，且时间范围不超过90天。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-09-29OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情