文档中心 API文档 查询5分钟明细的TOP-IP

查询5分钟明细的TOP-IP

更新时间:2022-12-11 23:33:30

适用产品

网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案

接口描述

查询多域名的5分钟明细的访客 TOP IP

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Body 参数

参数名称类型必填描述
dateFrom
String开始时间: 1.时间格式为yyyy-MM-ddTHH:mm:ss+08:00,例如,2019-01-01T10:00:00+08:00(为北京时间2019年1月1日10点0分0秒); 2.不能大于当前时间 3.最多可获取最近半年(183天)的数据。
dateTo
String结束时间: 1.时间格式为yyyy-MM-ddTHH:mm:ss+08:00,例如,2019-01-01T10:00:00+08:00(为北京时间2019年1月1日10点0分0秒); 2.结束时间需大于开始时间,结束时间如果大于当前时间,取当前时间。 3.dateFrom,dateTo二者都未传,默认查询过去的24小时;如仅有一个未传,抛异常 4.默认查询时间间隔7天,允许查询最大时间间隔:31天,即dateFrom和dateTo相差不能超过31天(可联系技术支持调整)。
domain
List域名: 1.可传递域名数量上限默认为20个(可联系技术支持调整)。 2.自动过滤掉非法域名(如传递非法域名,会被过滤掉,查询结果只返回合法域名的数据) 3.未传递该入参时,默认查询账号下所有域名,但当账号下域名数量超过上限时提示错误
orderBy
String排序: 1.可选值为:bandwidth 、request、flow 2.不传默认 bandwidth

返回参数

Body 参数

参数名称类型描述
code
String请求结果状态码
message
String请求结果信息
data
List请求结果的详细数据
timestamp
Stringtimestamp
domainData
List域名数据
domain
String域名
ipData
List
ip
Stringip,默认 TOP 100
value
String 1.流量:计量单位MB,保留2位小数 2.带宽:计量单位Mbps,保留2位小数 3.请求数

错误码

错误代码(code)描述(message)HTTP状态码语义
24102013The accept header specified in your request is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
24102020The value of X-Time-Zone header specified in your request in invalid.400请求头时区不合法
24102002There was an error in the body of your HTTP request.400请求体格式错误
24102006The date specified is invalid.400dateFrom或dateTo不符合规范或时间区间不合法
24102007You cannot specify a period greater than %d minute(s).400dateFrom和dateTo相差超过限制值
24102019The request was rejected because the number of domain(%d) exceeds the limit (%d).400传递的域名个数超过账号限制
24102008param: domain is null or invalid.400参数domain格式不符合规范
24102500We encountered an internal error. Please try again.500系统发生错误
24102008param: orderBy is null or invalid.400参数orderBy不符合规范

示例

JSON
XML
JSON
请求示例
复制代码 复制成功
#!/bin/bash
# Please remember to change the param (-H "X-Time-Zone") in this demo to the TimeZone you want in response

username='example_username'

apiKey='example_apiKey'

date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`

password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`

curl -i --url "https://open.chinanetcenter.com/api/report/ip/top-details" \

-X "POST" \

-H "X-Time-Zone:GMT+08:00" \

-u "$username:$password" \

-H "Date: $date" \

-H "Accept: application/json" \

-d '{
"dateFrom": "2019-07-21T00:00:00+08:00",
"dateTo": "2019-07-21T23:00:00+08:00",
"domain": ["www.aaa.com","www.bbb.com"],
"orderBy": "request"

}'
返回示例
复制代码 复制成功
{

  "code": "0",

  "message": "success",

  "data": [

    {

      "timestamp": "2019-07-21 01:10",

      "domainData": [

        {

          "domain": "www.aaa.com",

          "ipData": [

            {

              "ip": "128.234.45.23",

              "value": "67565656"

            },

            {

              "ip": "192.168.1.1",

              "value": "48915269"

            },

            {

              "ip": "10.232.123.24",

              "value": "33253454"

            }

          ]

        },

        {

          "domain": "www.bbb.com",

          "ipData": [

            {

              "ip": "128.234.45.23",

              "value": "67565656"

            },

            {

              "ip": "192.168.1.1",

              "value": "48915269"

            },

            {

              "ip": "10.232.123.24",

              "value": "33253454"

            }

          ]

        }

      ]

    }

  ]

}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!