調用DescribeDomainBpsDataByLayer按協議分類獲取帶寬數據。
接口說明
- 單用戶調用頻率：20 次/秒。
- 如果您不指定 StartTime 和 EndTime，該接口返回過去 24 小時的數據；指定 StartTime 和 EndTime，該接口返回指定時間段的數據。
支持查詢的時間粒度
根據單次查詢的最大時間跨度不同，請求參數 Interval 支持不同的查詢數據時間粒度，對應的可查詢歷史數據時間范圍和數據延遲如下：
| 時間粒度 | 單次查詢的最大時間跨度 | 可查詢歷史數據時間范圍 | 數據延遲 |
|---|---|---|---|
| 5 分鐘 | 3 天 | 93 天 | 15 分鐘 |
| 1 小時 | 31 天 | 186 天 | 一般延遲 3-4 小時 |
| 1 天 | 90 天 | 366 天 | 一般延遲 4 小時，不超過 24 小時 |
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cdn:DescribeDomainBpsDataByLayer | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 否 | 需要查詢的加速域名，多個域名用半角逗號（,）分隔，一次最多支持 500 個域名查詢。 說明
不傳該參數，默認返回所有加速域名合并后的數據。
| example.com |
| StartTime | string | 否 | 獲取數據的起始時間點。 日期格式按照 ISO8601 表示法，并使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。 | 2020-05-06T07:10:00Z |
| EndTime | string | 否 | 獲取數據的結束時間點。 日期格式按照 ISO8601 表示法，并使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。 說明
結束時間需大于起始時間。
| 2020-05-06T07:20:00Z |
| Interval | string | 否 | 指定查詢數據的時間粒度，單位：秒。 根據單次查詢的最大時間跨度不同，該參數支持 300（5 分鐘）、3600（1 小時）和 86400（1 天）取值，具體請參見使用說明中支持查詢的時間粒度。 | 300 |
| IspNameEn | string | 否 | 運營商英文名。通過 DescribeCdnRegionAndIsp 接口獲得，默認查詢所有運營商。 | unicom |
| LocationNameEn | string | 否 | 地域英文名。通過 DescribeCdnRegionAndIsp 接口獲得，默認查詢所有地域。 | beijing |
| Layer | string | 否 | 查詢維度。
默認值為 all。 | IPv4 |
返回參數
示例
正常返回示例
JSON格式
{
"DataInterval": "300",
"RequestId": "C565B910-BC3B-467B-9046-2A48566EA967",
"BpsDataInterval": {
"DataModule": [
{
"Value": "75.68",
"TrafficValue": "2838",
"TimeStamp": "2020-05-06T07:10:00Z"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 請同時提供開始時間和結束時間。 |
| 400 | InvalidStartTime.Malformed | The specified value of parameter StartTime is malformed. | 開始時間格式錯誤。日期格式請參考所調用API的幫助文檔說明。 |
| 400 | InvalidEndTime.Malformed | The specified value of parameter EndTime is malformed. | 參數EndTime格式錯誤。 |
| 400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | 指定的EndTime與StartTime不匹配，StartTime應早于EndTime。 |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 開始時間設置錯誤，請檢查更新后重試。 |
| 403 | InvaildParameter | The parameter you provided is invalid. | 域名不能包含下劃線、斜杠等特殊符號，請檢查域名格式后重新填寫 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-01-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |