調用DescribeDomainUsageData查詢網域名稱在特定計費地區的用量資料。
- 用量資料包括流量、頻寬和請求數三大類,單位分別為Byte、bps和次數。
- 單使用者調用頻率:10次/秒。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomainUsageData |
系統規定參數。取值:DescribeDomainUsageData。 |
EndTime | String | 是 | 2015-12-10T22:00:00Z |
擷取資料的結束時間點。 日期格式按照ISO 8601標記法,並使用UTC時間,格式為yyyy-MM-ddTHH:mm:ssZ。 说明
結束時間需晚於起始時間,且時間相差不能超過31天。
|
Field | String | 是 | bps |
請求的資料類型。取值:
说明
acc不支援根據
Area參數查詢。
|
StartTime | String | 是 | 2015-12-10T20:00:00Z |
擷取資料的起始時間點。 日期格式按照ISO 8601標記法,並使用UTC時間,格式為yyyy-MM-ddTHH:mm:ssZ。 说明
查詢資料粒度為5分鐘。
|
Type | String | 否 | static |
需要擷取的用量類型。取值:
|
DataProtocol | String | 否 | all |
需要擷取的資料的協議。取值:
|
DomainName | String | 否 | example.com |
需要查詢的加速網域名稱。支援批量查詢,多個網域名稱用英文逗號(,)分隔,一次最多可以查詢100個網域名稱。 说明
如果參數為空白,預設返回帳號下所有加速網域名稱合并後的資料。
|
Area | String | 否 | CN |
地區代號。取值:
|
Interval | String | 否 | 300 |
強制指定擷取指定時間粒紋的資料,單位為秒。支援300(5分鐘)、3600(1小時)和86400(1天)。
|
參數組合說明
計費資料和參數取值的對應關係如下表,具體調用方法可參見請求樣本。
計費資料 |
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 |
返回資料
名稱 | 類型 | 樣本值 | 描述 |
---|---|---|---|
Area | String | CN |
用量地區。 |
DataInterval | String | 300 |
每條記錄的時間間隔,單位為秒。 |
DomainName | String | example.com |
加速網域名稱。 |
EndTime | String | 2015-12-10T22:00:00Z |
結束時間。 |
RequestId | String | B955107D-E658-4E77-B913-E0AC3D31693E |
請求ID。 |
StartTime | String | 2015-12-10T20:00:00Z |
開始時間。 |
Type | String | static |
用量類型。 |
UsageDataPerInterval | Array of DataModule |
每個時間間隔的流量資料。 |
|
DataModule | |||
PeakTime | String | 2015-12-10T21:30:00Z |
當Field為bps時,該值為峰值頻寬時刻,否則值和TimeStamp相同。 |
SpecialValue | String | 423304182 |
特殊用量。 说明
用來標記特殊情況下的用量值,沒有特殊計費可忽略該參數。
|
TimeStamp | String | 2015-12-10T21:30:00Z |
時間片起始時刻。 说明
返回資料中包含的多個
TimeStamp稱為時間片。
|
Value | String | 423304182 |
用量。 |
樣本
請求樣本
//擷取中國內地的流量 http(s)://cdn.aliyuncs.com/?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Field=traf &Area=CN &<公用請求參數> //擷取EU大區的頻寬 http(s)://cdn.aliyuncs.com/?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Field=bps &Area=EU &<公用請求參數> //擷取靜態HTTPS請求數 http(s)://cdn.aliyuncs.com/?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Type=static &DataProtocol=https &Field=acc &Area=all &<公用請求參數> //擷取動態HTTP請求數 http(s)://cdn.aliyuncs.com/?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Type=dynamic &DataProtocol=http &Field=acc &Area=all &<公用請求參數> //擷取動態HTTPS請求數 http(s)://cdn.aliyuncs.com/?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Type=dynamic &DataProtocol=https &Field=acc &Area=all &<公用請求參數> //擷取動態QUIC請求數 http(s)://cdn.aliyuncs.com?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Type=dynamic &DataProtocol=quic &Field=acc &Area=all &<公用請求參數> //擷取靜態QUIC請求數 http(s)://cdn.aliyuncs.com?Action=DescribeDomainUsageData &DomainName=example.com &StartTime=2015-12-10T20:00:00Z &EndTime=2015-12-10T22:00:00Z &Type=static &DataProtocol=quic &Field=acc &Area=all &<公用請求參數>
正常返回樣本
XML
格式
<DescribeDomainUsageDataResponse> <DomainName>example.com</DomainName> <DataInterval>300</DataInterval> <UsageDataPerInterval> <DataModule> <TimeStamp>2015-12-10T20:00:00Z</TimeStamp> <PeakTime>2015-12-10T20:05:00Z</PeakTime> <Value>423304182</Value> <SpecialValue>423304182</SpecialValue> </DataModule> <DataModule> <TimeStamp>2015-12-10T21:00:00Z</TimeStamp> <PeakTime>2015-12-10T21:30:00Z</PeakTime> <Value>454680793</Value> <SpecialValue>423304182</SpecialValue> </DataModule> </UsageDataPerInterval> <RequestId>B955107D-E658-4E77-B913-E0AC3D31693E</RequestId> <StartTime>2015-12-10T20:00Z</StartTime> <EndTime>2015-12-10T21:00Z</EndTime> <Area>CN</Area> <Type>traf</Type> </DescribeDomainUsageDataResponse>
JSON
格式
{ "DomainName": "example.com", "DataInterval": "300", "UsageDataPerInterval": { "DataModule": [ { "TimeStamp": "2015-12-10T20:00:00Z", "PeakTime": "2015-12-10T20:05:00Z", "Value": "423304182", "SpecialValue": "423304182" }, { "TimeStamp": "2015-12-10T21:00:00Z", "PeakTime": "2015-12-10T21:30:00Z", "Value": "454680793", "SpecialValue": "423304182" } ] }, "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E", "StartTime": "2015-12-10T20:00Z", "EndTime": "2015-12-10T21:00Z", "Area": "CN", "Type": "traf" }
錯誤碼
訪問 錯誤中心查看更多錯誤碼。