調用DescribeDomainTopClientIpVisit查詢加速網域名稱在指定時間範圍內按照訪問次數或流量排序的用戶端IP排行,支援擷取最近90天的資料。
- 如果您不指定StartTime和EndTime,該介面預設讀取過去24小時的資料;指定StartTime和EndTime時,按照指定的時間查詢。
- 該介面計算的資料粒度為1小時。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomainTopClientIpVisit |
系統規定參數,取值:DescribeDomainTopClientIpVisit。 |
DomainName | String | 否 | example.com |
加速網域名稱,多個網域名稱用半形逗號(,)分隔。 預設查詢所有加速網域名稱。 |
LocationNameEn | String | 否 | beijing |
地區英文名,多個用半形逗號(,)分隔,預設查詢全部地區。 通過 DescribeCdnRegionAndIsp獲得。 |
StartTime | String | 否 | 2019-09-30T16:00:00Z |
擷取資料起始時間點。日期格式按照ISO8601標記法,並使用UTC時間,格式為yyyy-MM-ddTHH:mm:ssZ。 |
EndTime | String | 否 | 2019-10-01T16:00:00Z |
擷取資料結束時間點。日期格式按照ISO8601標記法,並使用UTC時間,格式為yyyy-MM-ddTHH:mm:ssZ。 結束時間需大於起始時間。 |
SortBy | String | 否 | traf |
排序方式。取值:
|
Limit | String | 否 | 20 |
返回資料條目,最大值為100。 預設為20,即返回TOP 20的資料條目。 |
返回資料
名稱 | 類型 | 樣本值 | 描述 |
---|---|---|---|
ClientIpList | Array of ClientIp |
用戶端IP列表。 |
|
Acc | Long | 256 |
總請求次數。 |
ClientIp | String | 1.1.xxx |
IP地址,目前僅支援IPv4。 |
Rank | Integer | 2 |
代表該條記錄是TopN。 |
Traffic | Long | 1024 |
總流量,單位為Byte。 |
RequestId | String | 64D28B53-5902-409B-94F6-FD46680144FE |
請求ID。 |
樣本
請求樣本
http://cdn.aliyuncs.com/?Action=DescribeDomainTopClientIpVisit &DomainName=example.com &StartTime=2019-09-30T16:00:00Z &EndTime=2019-10-01T16:00:00Z &<公用請求參數>
正常返回樣本
XML
格式
<DescribeDomainTopClientIpVisitResponse> <RequestId>64D28B53-5902-409B-94F6-FD46680144FE</RequestId> <ClientIpList> <Rank>1</Rank> <ClientIp>1.1.xx</ClientIp> <Traffic>1024</Traffic> <Acc>128</Acc> </ClientIpList> <ClientIpList> <Rank>2</Rank> <ClientIp>2.2.xx</ClientIp> <Traffic>2048</Traffic> <Acc>256</Acc> </ClientIpList> </DescribeDomainTopClientIpVisitResponse>
JSON
格式
{ "RequestId": "64D28B53-5902-409B-94F6-FD46680144FE", "ClientIpList": [ { "Rank": 1, "ClientIp": "1.1.xx", "Traffic": 1024, "Acc": 128 }, { "Rank": 2, "ClientIp": "2.2.xx", "Traffic": 2048, "Acc": 256 } ] }
錯誤碼
HttpCode | 錯誤碼 | 錯誤資訊 | 描述 |
---|---|---|---|
400 | InvalidStartTime.Malformed | Specified StartTime is malformed. | 起始時間格式錯誤。日期格式請參考所調用API的協助文檔說明。 |
400 | InvalidEndTime.Malformed | Specified EndTime is malformed. | 結束時間格式錯誤。日期格式請參考所調用API的協助文檔說明。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 開始時間設定錯誤,請檢查更新後重試。 |
訪問 錯誤中心查看更多錯誤碼。