調用DescribeDomainUsageData查詢域名在特定計費區域的用量數據。
接口說明
- 單用戶調用頻率：10 次/秒。
- 支持查詢的時間粒度：根據單次查詢的最大時間跨度不同，請求參數 Interval 支持不同的查詢數據時間粒度，對應的可查詢歷史數據時間范圍和數據延遲如下：
| 時間粒度 | 單次查詢的最大時間跨度 | 可查詢歷史數據時間范圍 | 數據延遲 |
|---|---|---|---|
| 5 分鐘 | 3 天 | 93 天 | 15 分鐘 |
| 1 小時 | 7 天 | 186 天 | 一般延遲 3-4 小時 |
| 1 天 | 31 天 | 366 天 | 一般延遲 4 小時，不超過 24 小時 |
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cdn:DescribeDomainUsageData | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 否 | 需要查詢的加速域名。支持批量查詢，多個域名用英文逗號（,）分隔，一次最多可以查詢 100 個域名。 說明
如果參數為空，默認返回賬號下所有加速域名合并后的數據。
| example.com |
| StartTime | string | 是 | 獲取數據的起始時間點。 日期格式按照 ISO 8601 表示法，并使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。 說明
查詢數據時間粒度為 5 分鐘。
| 2015-12-10T20:00:00Z |
| EndTime | string | 是 | 獲取數據的結束時間點。 日期格式按照 ISO 8601 表示法，并使用 UTC 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。 說明
結束時間需晚于起始時間，且時間相差不能超過 31 天。
| 2015-12-10T22:00:00Z |
| Field | string | 是 | 請求的數據類型。取值：
說明
acc 不支持根據 Area 參數查詢。
| bps |
| Type | string | 否 | 需要獲取的用量類型。取值：
| static |
| DataProtocol | string | 否 | 需要獲取的數據的協議。取值：
| all |
| Area | string | 否 | 區域代號。取值：
| CN |
| Interval | string | 否 | 強制指定獲取指定時間粒度的數據，單位為秒。支持 300（5 分鐘）、3600（1 小時）和 86400（1 天）。
| 300 |
參數組合說明
計費數據和參數取值的對應關系如下表，具體調用方法可參見請求示例。
| 計費數據 | DataProtocol 參數取值 | Type 參數取值 | Field 參數取值 | Area 參數取值 |
|---|---|---|---|---|
| 流量 | all 或不傳 | all 或不傳 | traf | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |
| 帶寬 | all 或不傳 | all 或不傳 | bps | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |
| 靜態 HTTPS 請求數 | https | static | acc | all |
| 動態 HTTP 請求數 | http | dynamic | acc | all |
| 動態 HTTPS 請求數 | https | dynamic | acc | all |
| 動態 QUIC 請求數 | quic | dynamic | acc | all |
| 靜態 QUIC 請求數 | quic | static | acc | all |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"DomainName": "example.com",
"StartTime": "2015-12-10T20:00:00Z",
"EndTime": "2015-12-10T22:00:00Z",
"Type": "bps",
"Area": "CN",
"DataInterval": "300",
"UsageDataPerInterval": {
"DataModule": [
{
"Value": "423304182",
"TimeStamp": "2015-12-10T21:30:00Z",
"PeakTime": "2015-12-10T21:30:00Z",
"SpecialValue": "423304182"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | 參數錯誤 |
| 400 | InvalidParameterType | The specified Type is invalid. | Type參數錯誤，請確認后輸入 |
| 400 | InvalidParameterField | The specified Field is invalid. | Field參數錯誤，請確認后輸入 |
| 400 | InvalidParameterStartTime | The parameter StartTime is invalid. | 參數StartTime無效。 |
| 400 | InvalidParameterEndTime | The parameter EndTime is invalid. | 參數EndTime無效。 |
| 400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | 指定的EndTime與StartTime不匹配，StartTime應早于EndTime。 |
| 400 | InvalidIntervalParameter | The specified Interval is invalid. | 指定的時間粒度無效。 |
| 400 | InvalidTimeSpan | The time span exceeds the limit. | 時間跨度超過限制，請參照接口文檔，配置合理查詢跨度。 |
| 400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 開始時間設置錯誤，請檢查更新后重試。 |
| 400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. | 開始時間或結束時間格式錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-18 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-06-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-06-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-03-16 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |