DescribeLiveDomainBpsDataByLayer - 按协议分类查询域名带宽及流量数据

调用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:DescribeLiveDomainBpsDataByLayer	get	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	无	无

请求参数

名称	类型	必填	描述	示例值
DomainName	string	否	播流域名。支持批量域名查询，多个域名用英文逗号（,）分隔。若参数为空，默认返回所有域名合并后数据。	pull.aliyundoc.com
StartTime	string	否	获取数据起始时间，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明不填默认读取过去 24 小时数据，最小数据粒度为 5 分钟。	2022-03-15T16:00:00Z
EndTime	string	否	结束时间需大于起始时间，格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-03-16T16:59:59Z
Interval	string	否	查询数据的时间粒度，单位：秒（s）。取值： 300 3600 86400 说明数据间隔≤3 天，支持数据时间粒度 300、3600、86400。 3 天＜数据间隔≤31 天，支持数据时间粒度 3600 和 86400。数据间隔＞31 天，支持数据时间粒度 86400。不传和传的值不支持时，使用默认值 300。	300
IspNameEn	string	否	运营商英文名，不传为所有运营商。说明您可调用 DescribeLiveRegionAndIsp 接口获取区域英文名和运营商英文名。	tele***
LocationNameEn	string	否	区域英文名，不传为所有区域。说明您可调用 DescribeLiveRegionAndIsp 接口获取区域英文名和运营商英文名。	hangzhou
Layer	string	否	查询维度。可选：网络层（IPv4、IPv6）应用层（http、https、quic） all（默认为 all）	all

返回参数

名称	类型	描述	示例值
	object
BpsDataInterval	array<object>	每个时间间隔的每秒访问次数 Bps。
DataModule	object	每个时间间隔的每秒访问次数 Bps。
TimeStamp	string	时间片起始时刻。	2022-03-15T16:00:00Z
TrafficValue	string	总流量，单位：Byte。	331
Value	string	峰值带宽，单位：bps。	0.56
DataInterval	string	每条数据记录的时间间隔，以秒为单位。	300
RequestId	string	请求 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	错误码	错误信息	描述
400	InvalidStartTime.Malformed	Specified parameter StartTime is not valid.	StartTime参数错误，请您确认该StartTime参数是否正确。
400	InvalidEndTime.Malformed	Specified parameter EndTime is not valid.	结束时间错误，请您确认结束时间是否正确。
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	结束时间与开始时间不匹配，请您确认时间的匹配度。
400	InvalidStartTime.ValueNotSupported	Specified end time does not math the specified start time,And the time range does not exceed 90 days.	开始时间与结束时间不匹配，开始时间不能晚于结束时间，且时间范围不超过90天。

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

变更历史

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