调用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代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDomainBpsDataByLayer

系统规定参数。取值:DescribeDomainBpsDataByLayer

DomainName String example.com

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

说明 不传该参数,默认返回所有加速域名合并后的数据。
StartTime String 2020-05-06T07:10:00Z

获取数据的起始时间点。

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

EndTime String 2020-05-06T07:20:00Z

获取数据的结束时间点。

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

说明 结束时间需大于起始时间。
Interval String 300

指定查询数据的时间粒度,单位:秒。

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

IspNameEn String unicom

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

LocationNameEn String beijing

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

Layer String IPv4

查询维度。

  • 网络层:IPv4IPv6
  • 应用层:httphttpsquic
  • all:包含网络层和应用层。

默认值为all

返回数据

名称 类型 示例值 描述
DataInterval String 300

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

RequestId String C565B910-BC3B-467B-9046-2A48566EA967

请求ID。

BpsDataInterval Array of DataModule

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

DataModule
Value String 75.68

峰值带宽,单位:bps。

TrafficValue String 2838

总流量,单位:Byte。

TimeStamp String 2020-05-06T07:10:00Z

时间片起始时刻。

示例

请求示例

http(s)://cdn.aliyuncs.com/?Action=DescribeDomainBpsDataByLayer
&DomainName=example.com
&StartTime=2020-05-06T07:10:00Z
&EndTime=2020-05-06T07:20:00Z
&Interval=300
&IspNameEn=unicom
&LocationNameEn=beijing
&Layer=IPv4
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDomainBpsDataByLayerResponse>
  <RequestId>C565B910-BC3B-467B-9046-2A48566EA967</RequestId>
  <DataInterval>300</DataInterval>
  <BpsDataInterval>
        <DataModule>
              <Value>75.68</Value>
              <TrafficValue>2838</TrafficValue>
              <TimeStamp>2020-05-06T07:10:00Z</TimeStamp>
        </DataModule>
        <DataModule>
              <Value>99138.85333333333</Value>
              <TrafficValue>3717707</TrafficValue>
              <TimeStamp>2020-05-06T07:15:00Z</TimeStamp>
        </DataModule>
  </BpsDataInterval>
</DescribeDomainBpsDataByLayerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidStartTime.Malformed Specified start time is malformed. 开始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400 InvalidEndTime.Malformed Specified end time is malformed. 结束时间格式错误。
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 请检查时间设置是否正确,结束时间不能小于或等于开始时间。

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