調用本介面查詢加速網域名稱的流量資料,相比DescribeVodDomainTrafficData介面,本介面支援查詢的資料時間粒紋更小(最小為1分鐘),資料延遲更低(最少為5分鐘),但可查詢的歷史資料時間範圍更短(最長可查詢最近186天的資料)。
介面說明
目前該介面服務地址僅支援:華東 2(上海)。
支援批量查詢,一次最多查詢 100 個網域名稱資料。
如果您不指定
StartTime和EndTime,該介面預設返回過去 1 小時的資料;指定StartTime和EndTime,該介面返回指定時間段的資料。
返回資料時間粒紋
根據您指定StartTime和EndTime時間跨度,會返回不同的資料時間粒紋,對應的可查詢歷史資料時間範圍和資料延遲如下:
| 時間粒紋 | 單次查詢的時間跨度 | 可查詢歷史資料時間範圍 | 資料延遲 |
| 1 分鐘 | 單次查詢的時間跨度 ≤ 1 小時 | 7 天 | 5 分鐘 |
| 5 分鐘 | 1 小時 < 單次查詢的時間跨度 < 3 天 | 93 天 | 15 分鐘 |
| 1 小時 | 3 天 ≤ 單次查詢的時間跨度 <31 天 | 186 天 | 一般延遲 3-4 小時 |
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
vod:DescribeVodDomainRealTimeTrafficData |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DomainName |
string |
是 |
要查詢的加速網域名稱。
|
example.com |
| StartTime |
string |
否 |
擷取資料的起始時間點。 日期格式按照 ISO8601 標記法,並使用 UTC 時間,格式為:yyyy-MM-ddTHH:mm:ssZ。 |
2019-12-10T20:00:00Z |
| EndTime |
string |
否 |
擷取資料的結束時間點。 日期格式按照 ISO8601 標記法,並使用 UTC 時間,格式為:yyyy-MM-ddTHH:mm:ssZ。 說明
結束時間需大於起始時間。 |
2019-12-10T20:01:00Z |
| IspNameEn |
string |
否 |
電訊廠商英文名。不傳該參數預設查詢所有電訊廠商。 |
telecom |
| LocationNameEn |
string |
否 |
地區英文名。不傳該參數預設查詢所有地區。 |
shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| EndTime |
string |
資料的結束時間點。 |
2019-12-10T20:01:00Z |
| StartTime |
string |
資料的起始時間點。 |
2019-12-10T20:00:00Z |
| RequestId |
string |
請求 ID。 |
A666D44F-19D6-490E-97CF-1A64AB962C57 |
| DomainName |
string |
加速網域名稱。 |
example.com |
| DataInterval |
string |
每條資料的時間間隔,即資料的時間粒紋,單位:秒。 根據單次查詢的時間跨度不同,該參數固定返回 60(1 分鐘)、300(5 分鐘)或 3600(1 小時),具體請參見介面說明中的返回資料時間粒紋。 |
60 |
| RealTimeTrafficDataPerInterval |
object |
||
| DataModule |
array<object> |
每個時間間隔的流量資料詳情。 |
|
|
object |
|||
| Value |
string |
流量資料,單位:Byte。 |
0 |
| TimeStamp |
string |
資料時間戳記。日期格式按照 ISO8601 標記法,並使用 UTC 時間。 |
2019-12-10T20:00:00Z |
樣本
正常返回樣本
JSON格式
{
"EndTime": "2019-12-10T20:01:00Z",
"StartTime": "2019-12-10T20:00:00Z",
"RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
"DomainName": "example.com",
"DataInterval": "60",
"RealTimeTrafficDataPerInterval": {
"DataModule": [
{
"Value": "0",
"TimeStamp": "2019-12-10T20:00:00Z"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MissingParameter | StartTime and EndTime can not be single. | |
| 400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 開始時間格式錯誤。 |
| 400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 結束時間格式錯誤。 |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | |
| 400 | Abs.DomainName.Malformed | The size of DomainName is too big. | |
| 400 | InvalidInterval.Malformed | Specified Interval is malformed. | |
| 400 | InvalidIspParameter | The specified Isp is invalid. | |
| 400 | InvalidLocName | The specified LocName is not supported. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。