調用DescribeDomainUsageData查詢網域名稱在特定計費地區的用量資料。
介面說明
單使用者調用頻率:10 次/秒。
支援查詢的時間粒紋:根據單次查詢的最大時間跨度不同,請求參數 Interval 支援不同的查詢資料時間粒紋,對應的可查詢歷史資料時間範圍和資料延遲如下:
| 時間粒紋 | 單次查詢的最大時間跨度 | 可查詢歷史資料時間範圍 | 資料延遲 |
| 5 分鐘 | 3 天 | 93 天 | 15 分鐘 |
| 1 小時 | 7 天 | 186 天 | 一般延遲 3-4 小時 |
| 1 天 | 31 天 | 366 天 | 一般延遲 4 小時,不超過 24 小時 |
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cdn:DescribeDomainUsageData |
none |
*Domain
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
| ServiceType |
string |
否 |
參數組合說明
計費資料和參數取值的對應關係如下表,具體調用方法可參見請求樣本。
| 計費資料 | 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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
參數列表。 |
||
| RequestId |
string |
請求 ID。 |
B955107D-E658-4E77-B913-E0AC3D31693E |
| DomainName |
string |
加速網域名稱。 |
example.com |
| StartTime |
string |
開始時間。 |
2015-12-10T20:00:00Z |
| EndTime |
string |
結束時間。 |
2015-12-10T22:00:00Z |
| Type |
string |
用量類型。 |
bps |
| Area |
string |
用量地區。 |
CN |
| DataInterval |
string |
每條記錄的時間間隔,單位為秒。 |
300 |
| UsageDataPerInterval |
object |
||
| DataModule |
array<object> |
每個時間間隔的流量資料。 |
|
|
object |
每個時間間隔的流量資料解釋。 |
||
| Value |
string |
用量。 |
423304182 |
| TimeStamp |
string |
時間片起始時刻。 說明
返回資料中包含的多個 TimeStamp 稱為時間片。 |
2015-12-10T21:30:00Z |
| PeakTime |
string |
當 Field 為 bps 時,該值為峰值頻寬時刻,否則值和 TimeStamp 相同。 |
2015-12-10T21:30:00Z |
| SpecialValue |
string |
特殊用量。 說明
用來標記特殊情況下的用量值,沒有特殊計費可忽略該參數。 |
423304182 |
樣本
正常返回樣本
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"
}
]
}
}
異常返回樣本
JSON格式
http://cdn.aliyuncs.com?Action=DescribeDomainUsageData&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T22:00:00Z
&Field=bps
&Area=EU
&<公用請求參數>
錯誤碼
|
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. | 開始時間或結束時間格式錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。