调用DescribeLiveDomainBpsDataByLayer按协议分类获取域名带宽及流量信息。
使用说明
支持数据存储时长90天。
支持批量域名查询,多个域名之间用英文逗号(,)分隔,最多支持500个域名。多个域名会按照聚合结果输出。
StartTime和EndTime数据间隔跨度不同返回时间粒度也不同,具体如下:
- 数据间隔≤3天,返回时间粒度五分钟。
- 3天<数据间隔≤31天,返回时间粒度1小时。
- 数据间隔>31天,返回时间粒度1天。
说明 如果StartTime和EndTime均未指定数值,默认返回当前时间起24小时内数据。
QPS限制
本接口的单用户QPS限制为20次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | DescribeLiveDomainBpsDataByLayer | 操作接口名,系统规定参数。取值:DescribeLiveDomainBpsDataByLayer 。 |
DomainName | String | 否 | pull.aliyundoc.com | 播流域名。 说明
|
StartTime | String | 否 | 2022-03-15T16:00:00Z | 获取数据起始时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 不填默认读取过去24小时数据,最小数据粒度为5分钟。 |
EndTime | String | 否 | 2022-03-16T16:59:59Z | 结束时间需大于起始时间,格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
Interval | String | 否 | 300 | 查询数据的时间粒度,单位:秒(s)。取值:
|
IspNameEn | String | 否 | tele*** | 运营商英文名,不传为所有运营商。 说明 您可调用DescribeLiveRegionAndIsp接口获取区域英文名和运营商英文名。 |
LocationNameEn | String | 否 | hangzhou | 区域英文名,不传为所有区域 。 说明 您可调用DescribeLiveRegionAndIsp接口获取区域英文名和运营商英文名。 |
Layer | String | 否 | all | 查询维度。可选:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
BpsDataInterval | Array of DataModule | 每个时间间隔的每秒访问次数Bps。 |
|
DataModule | |||
TimeStamp | String | 2022-03-15T16:00:00Z | 时间片起始时刻。 |
TrafficValue | String | 331 | 总流量,单位:Byte。 |
Value | String | 0.56 | 峰值带宽,单位:bps。 |
DataInterval | String | 300 | 每条数据记录的时间间隔,以秒为单位。 |
RequestId | String | BEA5625F-8FCF-48F4-851B-2A48566EA967 | 请求ID。 |
示例
请求示例
http://live.aliyuncs.com/?Action=DescribeLiveDomainBpsDataByLayer&DomainName=pull.aliyundoc.com
&StartTime=2022-03-15T16:00:00Z
&EndTime=2022-03-16T16:59:59Z
&<公共请求参数>
正常返回示例
XML
格式
<DescribeLiveDomainBpsDataByLayerResponse>
<RequestId>BEA5625F-8FCF-48F4-851B-2A48566EA967</RequestId>
<DataInterval>300</DataInterval>
<BpsDataInterval>
<DataModule>
<Value>0.56</Value>
<TrafficValue>331</TrafficValue>
<TimeStamp>2022-03-15T16:00:00Z</TimeStamp>
</DataModule>
</BpsDataInterval>
</DescribeLiveDomainBpsDataByLayerResponse>
JSON
格式
{
"RequestId":"BEA5625F-8FCF-48F4-851B-2A48566EA967",
"DataInterval":"300",
"BpsDataInterval": {
"DataModule": [
{
"Value":"0.56",
"TrafficValue":"331",
"TimeStamp":"2022-03-15T16:00:00Z"
}
]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
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天。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?