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

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

接口说明

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

支持查询的时间粒度

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

时间粒度	单次查询的最大时间跨度	可查询历史数据时间范围	数据延迟
5 分钟	3 天	93 天	15 分钟
1 小时	31 天	186 天	一般延迟 3-4 小时
1 天	90 天	366 天	一般延迟 4 小时，不超过 24 小时

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cdn:DescribeDomainBpsDataByLayer	none	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	需要查询的加速域名，多个域名用半角逗号（,）分隔，一次最多支持 500 个域名查询。说明不传该参数，默认返回所有加速域名合并后的数据。	example.com
StartTime	string	否	获取数据的起始时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-05-06T07:10:00Z
EndTime	string	否	获取数据的结束时间点。日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。说明结束时间需大于起始时间。	2020-05-06T07:20:00Z
Interval	string	否	指定查询数据的时间粒度，单位：秒。根据单次查询的最大时间跨度不同，该参数支持 300（5 分钟）、3600（1 小时）和 86400（1 天）取值，具体请参见使用说明中支持查询的时间粒度。	300
IspNameEn	string	否	运营商英文名。通过 DescribeCdnRegionAndIsp 接口获得，默认查询所有运营商。	unicom
LocationNameEn	string	否	地域英文名。通过 DescribeCdnRegionAndIsp 接口获得，默认查询所有地域。	beijing
Layer	string	否	查询维度。网络层：IPv4、IPv6。应用层：http、https、quic。 all：包含网络层和应用层。默认值为 all。	IPv4

返回参数

名称	类型	描述	示例值
	object
DataInterval	string	每条记录的时间间隔，单位为秒。	300
RequestId	string	请求 ID。	C565B910-BC3B-467B-9046-2A48566EA967
BpsDataInterval	array<object>	每个时间间隔的每秒访问次数 Bps 数据列表。
DataModule	object
Value	string	峰值带宽，单位：bps。	75.68
TrafficValue	string	总流量，单位：Byte。	2838
TimeStamp	string	时间片起始时刻。	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	错误码	错误信息	描述
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	请同时提供开始时间和结束时间。
400	InvalidStartTime.Malformed	The specified value of parameter StartTime is malformed.	开始时间格式错误。日期格式请参考所调用API的帮助文档说明。
400	InvalidEndTime.Malformed	The specified value of parameter EndTime is malformed.	参数EndTime格式错误。
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	指定的EndTime与StartTime不匹配，StartTime应早于EndTime。
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	开始时间设置错误，请检查更新后重试。
403	InvaildParameter	The parameter you provided is invalid.	域名不能包含下划线、斜杠等特殊符号，请检查域名格式后重新填写

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

变更历史

变更时间	变更内容概要	操作
2024-01-22	OpenAPI 错误码发生变更	查看变更详情
2023-06-13	OpenAPI 错误码发生变更	查看变更详情