全部产品
Search

搜索本产品

    CDN：DescribeDomainBpsDataByLayer - 查询带宽-按协议

    文档中心

    CDN：DescribeDomainBpsDataByLayer - 查询带宽-按协议

    更新时间：Feb 22, 2023

    调用DescribeDomainBpsDataByLayer按协议分类获取带宽数据。

    接口说明

    • 单用户调用频率：20次/秒。
    • 如果您不指定StartTime和EndTime，该接口返回过去24小时的数据；指定StartTime和EndTime，该接口返回指定时间段的数据。

    支持查询的时间粒度

    根据单次查询的最大时间跨度不同，请求参数Interval支持不同的查询数据时间粒度，对应的可查询历史数据时间范围和数据延迟如下：

    时间粒度单次查询的最大时间跨度可查询历史数据时间范围数据延迟
    5分钟3天93天15分钟
    1小时31天186天4小时
    1天366天366天次日凌晨4点

    调试

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

    调试

    授权信息

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

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

    请求参数

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

    需要查询的加速域名，多个域名用半角逗号（,）分隔，一次最多支持500个域名查询。

    说明不传该参数，默认返回所有加速域名合并后的数据。
    		example.com
    StartTimestring否

    获取数据的起始时间点。

    日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

    		2020-05-06T07:10:00Z
    EndTimestring否

    获取数据的结束时间点。

    日期格式按照ISO8601表示法，并使用UTC+0时间，格式为yyyy-MM-ddTHH:mm:ssZ。

    说明结束时间需大于起始时间。
    		2020-05-06T07:20:00Z
    Intervalstring否

    指定查询数据的时间粒度，单位：秒。

    根据单次查询的最大时间跨度不同，该参数支持300（5分钟）、3600（1小时）和86400（1天）取值，具体请参见使用说明中支持查询的时间粒度。

    		300
    IspNameEnstring否

    运营商英文名。通过DescribeCdnRegionAndIsp接口获得，默认查询所有运营商。

    		unicom
    LocationNameEnstring否

    地域英文名。通过DescribeCdnRegionAndIsp接口获得，默认查询所有地域。

    		beijing
    Layerstring否

    查询维度。

    • 网络层：IPv4、IPv6。
    • 应用层：http、https、quic。
    • all：包含网络层和应用层。

    默认值为all。

    		IPv4

    返回参数

    名称类型描述示例值
    object
    DataIntervalstring

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

    		300
    RequestIdstring

    请求ID。

    		C565B910-BC3B-467B-9046-2A48566EA967
    BpsDataIntervalarray

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

    object
    Valuestring

    峰值带宽，单位：bps。

    		75.68
    TrafficValuestring

    总流量，单位：Byte。

    		2838
    TimeStampstring

    时间片起始时刻。

    		2020-05-06T07:10:00Z

    示例

    正常返回示例

    JSON格式

    {
  "DataInterval": "300",
  "RequestId": "C565B910-BC3B-467B-9046-2A48566EA967",
  "BpsDataInterval": {
    "DataModule": [
      {
        "Value": "75.68",
        "TrafficValue": "2838",
        "TimeStamp": "2020-05-06T07:10:00Z"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400MissingTimeParameterStartTime and EndTime can not be single.-
    400InvalidStartTime.MalformedSpecified start time is malformed.开始时间格式错误。日期格式请参考所调用API的帮助文档说明。
    400InvalidEndTime.MalformedSpecified end time is malformed.结束时间格式错误。
    400InvalidEndTime.MismatchSpecified end time does not math the specified start time.请检查时间设置是否正确，结束时间不能小于或等于开始时间。
    400InvalidStartTime.ValueNotSupportedSpecified end time does not math the specified start time.-

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