调用DescribeDomainTopClientIpVisit获取加速域名在指定时间范围内按照访问次数或流量排序的Client 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

排序方式。

  • traf(默认值):流量。
  • acc:访问次数。
Limit String 20

返回数据条目,最大值为100。

默认为20,即返回TOP 20的数据条目。

返回数据

名称 类型 示例值 描述
ClientIpList Array

Client 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.xxx</ClientIp>
        <Traffic>1024</Traffic>
        <Acc>128</Acc>
  </ClientIpList>
  <ClientIpList>
        <Rank>2</Rank>
        <ClientIp>2.2.xxx</ClientIp>
        <Traffic>2048</Traffic>
        <Acc>256</Acc>
  </ClientIpList>
</DescribeDomainTopClientIpVisitResponse>

JSON 格式

{
        "RequestId": "64D28B53-5902-409B-94F6-FD46680144FE",
    "ClientIpList": [
        {
            "Rank": 1,
            "ClientIp": "1.1.xxx",
            "Traffic": 1024,
            "Acc": 128
        },
        {
            "Rank": 2,
            "ClientIp": "2.2.xxx",
            "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. 开始时间设置错误,请检查更新后重试。

访问错误中心查看更多错误码。