調用本接口查詢加速域名的流量數據，相比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代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| 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 |
返回參數
示例
正常返回示例
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 狀態碼 | 說明 |
|---|---|---|---|
| Throttling | Request was denied due to request throttling. | 503 | 請求被流量控制限制。 |
| IllegalOperation | Illegal domain, operation is not permitted. | 403 | 非法域名, 無法操作。 |
| OperationDenied | Your account does not open CDN service yet. | 403 | 未開通 CDN 服務。 |
| OperationDenied | Your CDN service is suspended. | 403 | CDN 服務已被停止。 |
| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不屬于當前用戶。 |
| InvalidDomain.Offline | The domain provided is offline. | 404 | 域名已下線。 |
| ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中, 請稍后再試。 |
| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | 域名配置失敗。 |
| MissingParameter | StartTime and EndTime can not be single. | 400 | StartTime 和 EndTime 不能單獨設置。 |
| InvalidStartTime.Malformed | Specified start time is malformed. | 400 | StartTime 格式錯誤。 |
| InvalidEndTime.Malformed | Specified end time is malformed. | 400 | EndTime 格式錯誤。 |
| InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | 400 | EndTime 小于 StartTime。 |
| InvalidStartTime.ValueNotSupported | Specified end time does not match the specified start time. | 400 | EndTime 和 StartTime 差值超過 90 天。 |