调用DescribeDomainPathData按目录维度获取监控数据,包括流量和访问次数。
接口说明
该接口仅支持白名单用户(域名峰值带宽 10 Gbps 以上)调用,需要提交工单申请,符合条件的情况下将在后台进行配置。
单用户调用频率:6000 次/分。
目前仅支持对账号下的指定域名开启目录维度带宽统计,不支持对全部域名开启。
域名下所有文件的平均大小需要大于 1 MB。
每个域名的目录数量不超过 100 个,超过 100 个目录的情况下,数据的精度将会降低,查询的不准确。
不指定 StartTime 和 EndTime 时,默认读取过去 24 小时的数据,同时支持按指定的起止时间查询,两者需要同时指定。
最多可获取最近 30 天的数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cdn:DescribeDomainPathData |
get |
*Domain
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
取得第几页。从 1 开始。 |
1 |
| PageSize |
integer |
否 |
分页大小。 取值:1~1000 之间的任意整数。 |
20 |
| Path |
string |
否 |
路径,以正斜线(/)开头,不填表示查询所有路径。如果路径是目录,需要以正斜线(/)结尾。 说明
路径信息不支持模糊匹配,需要指定查询的目录深度,只能设置为一个固定值,例如设置一级目录/path/,表示数据统计时,固定统计一级目录的带宽。 |
/path/ |
| StartTime |
string |
否 |
开始时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-DDThh:mm:ssZ。 例如:2016-10-20T04:00:00Z。 |
2016-10-20T04:00:00Z |
| EndTime |
string |
否 |
结束时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-DDThh:mm:ssZ。开始时间和结束时间,间隔小于 30 天。例如:2016-10-21T04:00:00Z。 |
2016-10-21T04:00:00Z |
| DomainName |
string |
是 |
加速域名。 说明
仅支持单个域名查询。 |
example.com |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| EndTime |
string |
结束时间。 |
2017-09-30T17:00:00Z |
| StartTime |
string |
开始时间。 |
2017-09-30T16:00:00Z |
| PageSize |
integer |
页面大小。 |
20 |
| PageNumber |
integer |
当前页码,从 1 开始计数。 |
1 |
| TotalCount |
integer |
路径带宽数据条数。 |
2 |
| DomainName |
string |
加速域名。 |
example.com |
| DataInterval |
string |
时间间隔,单位:秒。 |
300 |
| PathDataPerInterval |
object |
||
| UsageData |
array<object> |
路径带宽数据列表。 |
|
|
object |
|||
| Path |
string |
路径。 |
/path/ |
| Time |
string |
时间点。 |
2017-09-30T16:00:00Z |
| Acc |
integer |
访问次数。 |
10 |
| Traffic |
integer |
流量(B)。 |
346 |
| RequestId |
string |
请求 ID。 |
DE81639B-DAC1-4C76-AB72-F34B836837D5 |
示例
正常返回示例
JSON格式
{
"EndTime": "2017-09-30T17:00:00Z",
"StartTime": "2017-09-30T16:00:00Z",
"PageSize": 20,
"PageNumber": 1,
"TotalCount": 2,
"DomainName": "example.com",
"DataInterval": "300",
"PathDataPerInterval": {
"UsageData": [
{
"Path": "/path/",
"Time": "2017-09-30T16:00:00Z",
"Acc": 10,
"Traffic": 346
}
]
},
"RequestId": "DE81639B-DAC1-4C76-AB72-F34B836837D5"
}
异常返回示例
JSON格式
{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8","HostId":"cdn.aliyuncs.com","Code":"InternalError","Message":"The request processing has failed due to some unknown error."}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidPageSize.Malformed | PageSize must be of type Integer | |
| 400 | InvalidPageSize.ExceedsMaximum | PageSize should be less than or equal to 1000 | |
| 400 | InvalidPageSize.ExceedsMinimum | PageSize should be greater than or equal to 1 | |
| 400 | InvalidPath.Malformed | Path must be of type String | |
| 400 | InvalidStartTime.Malformed | StartTime must be of type String | |
| 400 | InvalidEndTime.Malformed | EndTime must be of type String | |
| 400 | InvalidDomainName.Malformed | DomainName must be of type String | |
| 400 | MissingParameter | DomainName is required | |
| 400 | InvalidDomainName.TooShort | DomainName should be at least 1 chars long | |
| 400 | InvalidPageNumber.Malformed | PageNumber must be of type Integer | |
| 400 | InvalidPageNumber.ExceedsMinimum | PageNumber should be greater than or equal to 1 | |
| 400 | InvalidTime.OverRange | Specified StartTime or EndTime is over range |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。