调用本接口查询加速域名的流量数据,相比DescribeVodDomainRealTimeTrafficData接口,本接口支持可查询的历史数据时间范围更长(最长可查询最近366天的数据),但其数据时间粒度更大(最小为5分钟),数据延迟更高。
接口说明
目前该接口服务地址仅支持:华东 2(上海)。
支持批量查询,一次最多查询 500 个域名数据。
如果您不指定
StartTime
和EndTime
,该接口默认返回过去 24 小时的数据;指定StartTime
和EndTime
,该接口返回指定时间段的数据。
返回数据时间粒度
根据您指定StartTime
和EndTime
的时间跨度,且未同时设置Interval
的情况下,默认返回的数据时间粒度,以及对应的可查询历史数据时间范围和数据延迟如下:
时间粒度 | 单次查询的时间跨度 | 可查询历史数据时间范围 | 数据延迟 |
5 分钟 | 单次查询的时间跨度 < 3 天 | 93 天 | 15 分钟 |
1 小时 | 3 天 ≤ 单次查询的时间跨度 < 31 天 | 186 天 | 一般延迟 3-4 小时 |
1 天 | 31 天 ≤ 单次查询的时间跨度 ≤ 366 天 | 366 天 | 一般延迟 4 小时,不超过 24 小时 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
vod:DescribeVodDomainTrafficData |
get |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
DomainName |
string |
否 |
要查询的加速域名。
|
example.com |
StartTime |
string |
否 |
获取数据起始时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2019-01-20T13:59:58Z |
EndTime |
string |
否 |
获取数据的结束时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为:yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。 |
2019-01-20T14:59:58Z |
Interval |
string |
否 |
设置查询数据的时间粒度。单位:秒。取值:300、3600 和 86400。不传和传的值不支持时,使用默认值。根据您指定的
|
300 |
IspNameEn |
string |
否 |
运营商英文名。不传入该参数,默认查询所有运营商。 |
unicom |
LocationNameEn |
string |
否 |
地域英文名。不传入该参数,默认查询所有地域。目前仅支持上海地域。 |
shanghai |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回结果。 |
||
EndTime |
string |
数据的结束时间点。 |
2019-01-20T14:59:58Z |
StartTime |
string |
数据的起始时间点。 |
2019-01-20T13:59:58Z |
RequestId |
string |
请求 ID。 |
D94E471F-1A27-442E-552D-D4D2000C**** |
DomainName |
string |
加速域名。 |
example.com |
TotalTraffic |
string |
总流量。 |
5906662826 |
DataInterval |
string |
每条记录的时间间隔,即数据的时间粒度。单位:秒。 |
300 |
TrafficDataPerInterval |
object |
||
DataModule |
array<object> |
每个时间间隔的流量数据列表。 |
|
object |
|||
HttpsDomesticValue |
string |
L1 节点的 HTTPS 流量(中国内地)。单位:Byte。 |
0 |
Value |
string |
总流量。单位:Byte。 |
0 |
OverseasValue |
string |
全球(不包含中国内地)流量。单位:Byte。 |
0 |
HttpsValue |
string |
L1 节点的 HTTPS 总流量。单位:Byte。 |
0 |
HttpsOverseasValue |
string |
L1 节点的 HTTPS 流量(全球(不包含中国内地))。单位:Byte。 |
0 |
TimeStamp |
string |
数据时间戳。日期格式按照 ISO8601 表示法,并使用 UTC 时间。 |
2019-01-20T13:59:58Z |
DomesticValue |
string |
中国内地流量。单位:Byte。 |
0 |
示例
正常返回示例
JSON
格式
{
"EndTime": "2019-01-20T14:59:58Z",
"StartTime": "2019-01-20T13:59:58Z",
"RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
"DomainName": "example.com",
"TotalTraffic": "5906662826",
"DataInterval": "300\n",
"TrafficDataPerInterval": {
"DataModule": [
{
"HttpsDomesticValue": "0",
"Value": "0",
"OverseasValue": "0",
"HttpsValue": "0",
"HttpsOverseasValue": "0",
"TimeStamp": "2019-01-20T13:59:58Z",
"DomesticValue": "0"
}
]
}
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 必须同时指定开始时间和结束时间 |
400 | InvalidStartTime.Malformed | The specified StartTime is invalid. | |
400 | InvalidEndTime.Malformed | The specified EndTime is invalid. | |
400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 结束时间早于开始时间 |
400 | InvalidStartTime.ValueNotSupported | The specified StartTime is invalid. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。