调用本接口查询加速流量或带宽用量数据。
接口说明
目前服务地址仅支持：华东 2（上海）。
支持批量域名查询，多个域名用逗号半角（,）分隔,最多可以一次查询 100 个域名。如果为空则返回账号下所有域名的数据。
最长可查询近 1 年的数据，单次查询跨度最长为 3 个月，查询时间为 1-3 天时，数据按小时粒度返回，查询时间大于 4 天，数据按天粒度返回。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:DescribeVodDomainUsageData |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DomainName |
string |
否 |
加速域名。若参数为空，默认返回所有加速域名合并后数据。支持批量查询，多个用半角逗号（,）分隔。 |
example.com |
| StartTime |
string |
是 |
获取数据起始时间点。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2015-12-10T10:20:00Z |
| EndTime |
string |
是 |
获取数据结束时间点，需晚于起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2015-12-10T12:20:00Z |
| Field |
string |
是 |
数据类型。取值：
|
bps |
| Type |
string |
否 |
需要获取的用量类型。取值：
|
static |
| Area |
string |
否 |
地域代号。默认为 CN 中国大陆。取值：
|
CN |
| Interval |
string |
否 |
强制指定获取指定时间粒度的数据，单位为秒。支持 300（5 分钟）、3600（1 小时）和 86400（1 天）。
|
300 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| EndTime |
string |
结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2015-12-10T12:20:00Z |
| Type |
string |
数据类型。取值：
|
bps |
| StartTime |
string |
开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2015-12-10T10:20:00Z |
| RequestId |
string |
请求 ID。 |
B955107D-E658-4E77-****-E0AC3D31693E |
| Area |
string |
用量区域。 |
CN |
| DomainName |
string |
加速域名信息。 |
example.com |
| DataInterval |
string |
每条记录的时间间隔。单位：秒。 |
300 |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
流量或带宽用量数据。 |
|
|
object |
|||
| Value |
string |
流量或带宽用量。单位：bit/second。 |
2592.3920000000003 |
| TimeStamp |
string |
时间片起始时刻。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
2015-12-10T10:00:00Z |
示例
正常返回示例
JSON格式
{
"EndTime": "2015-12-10T12:20:00Z",
"Type": "bps",
"StartTime": "2015-12-10T10:20:00Z",
"RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
"Area": "CN",
"DomainName": "example.com",
"DataInterval": "300",
"UsageDataPerInterval": {
"DataModule": [
{
"Value": "2592.3920000000003",
"TimeStamp": "2015-12-10T10:00:00Z"
}
]
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | 参数无效。 |
| 400 | InvalidParameterProduct | The specified parameter Product is invalid. | 指定的Product参数不合法，请参照文档修改。 |
| 400 | InvalidParameterArea | The specified parameter Area is invalid. | 指定的Area参数非法，请根据API文档修改。 |
| 400 | InvalidParameterField | The specified parameter Field is invalid. | 指定的Field参数非法，请参照API文档修改。 |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 开始时间格式错误。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 结束时间格式错误。 |
| 400 | InvalidEndTime.Mismatch | StartTime or EndTime is mismatch. | 开始时间与结束时间不匹配 |
| 400 | InvalidParameterInterval | The specified Interval is invalid. | 指定的时间粒度无效，请根据API文档输入所需的时间粒度。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。