調用DescribeDomainUsageData查詢域名在特定計費區域的用量數據。
使用說明
- 此接口支持批量域名查詢,多個域名用英文逗號(,)分隔,最多一次可以查詢100個域名。如果DomainName參數為空,則返回賬號下所有域名的數據。
- 用量數據包括流量、帶寬和請求數三類,單位分別為Byte、bps和次數。
- 如果不指定Interval參數,最長可查詢近1年的數據,單次查詢的最大時間跨度為31天。查詢時間為1~3天,數據按小時粒度返回;查詢時間大于3天,數據按天粒度返回。
- 指定Interval參數時,支持單次查詢的時間跨度、對應的可查詢歷史數據時間范圍和數據延遲如下:
時間粒度 |
單次查詢的最大時間跨度 |
可查詢歷史數據時間范圍 |
數據延遲 |
5分鐘 |
3天 |
93天 |
15分鐘 |
1小時 |
31天 |
186天 |
4小時 |
1天 |
90天 |
366天 |
次日凌晨4點 |
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。更多信息,請參見QPS限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeDomainUsageData | 系統規定參數。取值:DescribeDomainUsageData。 |
DomainName | String | 否 | example.com | 直播域名。
|
StartTime | String | 是 | 2015-12-10T20:00:00Z | 起始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
EndTime | String | 是 | 2015-12-10T21:00:00Z | 結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 需大于起始時間,且與起始時間相差不能超過31天。 |
Type | String | 否 | all | 需要獲取的用量類型。 當Field取值為bps或traf 時,該參數取值范圍:
當Field取值為req_traf或req_bps 時,該參數取值范圍:
|
Field | String | 是 | traf | 查詢用量的數據類型。取值:
|
Area | String | 否 | CN | 區域代號。支持:
說明 不傳值則默認為中國內地。海外大區說明:
|
DataProtocol | String | 否 | all | 需要獲取的數據的協議。取值:
|
Interval | String | 否 | 300 | 強制指定獲取指定時間粒度的數據,單位為秒。支持300(5分鐘)、3600(1小時)和86400(1天)。 |
接口查詢T時刻數據時,T+N時刻可獲取到穩態數據,N為2小時。
示例:當您查詢12月21日下午1點鐘數據,可在12月21日下午3點鐘獲取到1點及1點前的穩態數據。
返回數據
名稱 |
類型 |
示例值 |
描述 |
EndTime | String | 2015-12-10T21:00Z | 結束時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
Type | String | all | 用量類型。 |
StartTime | String | 2015-12-10T20:00Z | 開始時間。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
RequestId | String | B955107D-E658-4E77-B913-E0AC3D31693E | 請求ID。 |
Area | String | CN | 用量區域。 |
DomainName | String | example.com | 直播域名。 |
DataInterval | String | 300 | 每條記錄的時間間隔。單位:秒。 |
UsageDataPerInterval | Array of DataModule | 每條記錄的流量數據。 |
|
DataModule | |||
Value | String | 423304182 | 用量。
|
TimeStamp | String | 2015-12-10T20:00:00Z | 時間片起始時刻。格式為:yyyy-MM-ddTHH:mm:ssZ(UTC時間)。 |
示例
請求示例
http://live.aliyuncs.com/?Action=DescribeDomainUsageData&DomainName=example.com
&StartTime=2015-12-10T20:00:00Z
&EndTime=2015-12-10T21:00:00Z
&Type=all
&Area=CN
&<公共請求參數>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDomainUsageDataResponse>
<DomainName>example.com</DomainName>
<DataInterval>300</DataInterval>
<UsageDataPerInterval>
<DataModule>
<TimeStamp>2015-12-10T20:00:00Z</TimeStamp>
<Value>423304182</Value>
</DataModule>
<DataModule>
<TimeStamp>2015-12-10T20:05:00Z</TimeStamp>
<Value>454680793</Value>
</DataModule>
<DataModule>
<TimeStamp>2015-12-10T20:10:00Z</TimeStamp>
<Value>501718342</Value>
</DataModule>
<DataModule>
<TimeStamp>2015-12-10T20:15:00Z</TimeStamp>
<Value>434816025</Value>
</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>all</Type>
</DescribeDomainUsageDataResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DomainName" : "example.com",
"DataInterval" : "300",
"UsageDataPerInterval" : {
"DataModule" : [ {
"TimeStamp" : "2015-12-10T20:00:00Z",
"Value" : "423304182"
}, {
"TimeStamp" : "2015-12-10T20:05:00Z",
"Value" : "454680793"
}, {
"TimeStamp" : "2015-12-10T20:10:00Z",
"Value" : "501718342"
}, {
"TimeStamp" : "2015-12-10T20:15:00Z",
"Value" : "434816025"
} ]
},
"RequestId" : "B955107D-E658-4E77-B913-E0AC3D31693E",
"StartTime" : "2015-12-10T20:00Z",
"EndTime" : "2015-12-10T21:00Z",
"Area" : "CN",
"Type" : "all"
}
錯誤碼
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
400 | InvaildParameter | Invalid Parameter | 請求參數非法 |
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | StartTime參數錯誤,請您確認該StartTime參數是否正確。 |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 結束時間錯誤,請您確認結束時間是否正確。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 傳入的StartTime參數不支持。 |
400 | InvalidTime.Malformed | Specified Time is malformed. | 制定時間錯誤,請您確認該制定時間是否正確。 |
400 | InvalidParameterField | The specified Field is invalid. | Field參數錯誤,請確認后輸入 |
400 | InvalidParameterType | The specified Type is invalid. | Type參數錯誤,請確認后輸入 |
400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | 結束時間與開始時間不匹配,請您確認時間的匹配度。 |
400 | InvalidTimeSpan | The time span exceeds the limit. | 時間跨度超過限制,請參照接口文檔,配置合理查詢跨度。 |
訪問錯誤中心查看更多錯誤碼。
特殊錯誤碼
錯誤代碼 |
描述 |
HTTP 狀態碼 |
語義 |
Throttling |
Request was denied due to request throttling. |
503 |
請求被流量控制限制 |
IllegalOperation |
Illegal domain, operation is not permitted. |
403 |
非法域名,無法操作 |
OperationDenied |
Your account does not open Live service yet. |
403 |
未開通Live服務 |
OperationDenied |
Your Live service is suspended. |
403 |
Live服務已被停止 |
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 |
域名配置失敗 |
InvalidParameter |
Invalid Parameter. |
400 |
參數錯誤 |
InvalidParameterProduct |
Invalid Parameter Product. |
400 |
Product參數錯誤 |
InvalidParameterArea |
Invalid Parameter Area. |
400 |
Area參數錯誤 |
InvalidParameterField |
Invalid Parameter Field. |
400 |
Field參數錯誤 |
InvalidParameterStartTime |
Invalid Parameter StartTime. |
400 |
StartTime參數錯誤 |
InvalidParameterEndTime |
Invalid Parameter EndTime. |
400 |
EndTime參數錯誤 |
InvalidTimeRange |
StartTime and EndTime range should less than 1 month. |
400 |
EndTime和StartTime差值不能超過31天 |
InvalidParameterInterval |
Invalid Parameter Interval. |
400 |
Interval參數錯誤 |