調用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 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。