帮助与文档

分域名请求数查询 下载PDF文档

接口地址

请求URL: stat/request/eachDomain (GET)

接口请求域名: cdn.api.baishan.com
接口版本: v2

接口描述

用于查询多个加速域名,并返回每个加速域名的请求数数据。

数据统计的时间粒度默认为5分钟。接口调用频率限制见响应头部(Response Header)。

输入参数

公有参数:用户的 token 可向值班同事获取。

请求参数(GET)

参数添加到在url的query部分,例如: ?key1=value1&key2=value2。

参数名数据类型是否必须说明
domainsstring指定查询的加速域名,最多可一次性查询10个加速域名。当查询多个加速域名时,返回每个加速域名的请求数数据。
start_timestring指定查询起始时间,如:2020-06-01 10:00、2020-06-01,其中2020-06-01代表以 2020-06-01 00:00:00作为起始时间。
返回结果大于等于指定时间,根据指定时间粒度不同,会进行向前规整,如:2020-06-01 10:03在按5分钟的时间粒度查询时,返回的第一个数据对应时间点为2020-06-01 10:00。
起始时间与结束时间间隔小于等于31天。
end_timestring指定查询结束时间,如:2020-06-02 10:00、2020-06-02,其中2020-06-02代表以 2020-06-02 23:59:59作为结束时间。
返回结果小于等于指定时间,根据指定时间粒度不同,会进行向前规整,如:2020-06-02 10:17在按5分钟的时间粒度查询时,返回的第一个数据对应时间点为2020-06-02 10:15:00。
起始时间与结束时间间隔小于等于31天。
gradstring指定数据统计的时间粒度查询:
minute:1分钟粒度:查询时间跨度为一天
minute5:5分钟粒度:查询时间跨度为31天
hour:小时粒度:查询时间跨度为31天
day:天粒度:查询时间跨度为93三个月
不填充时,默认为minute5。
stat_is_forwardstring指定查询时间点的含义,以grad=minute5为例:
0:时间点后指向,如2020-06-01 10:00 代表 [2020-06-01 10:00:00, 2020-06-01 10:04:59]
1:时间点前指向,如2020-06-01 10:05 代表 [2020-06-01 10:00:00, 2020-06-01 10:04:59]
不填充时,默认值为0。
ip_protocolstring指定IP协议查询:
ipv4:查询ipv4的统计数据
ipv6:查询ipv6的统计数据
不填充时,默认返回ipv4和ipv6的汇总数据。
query_areastring指定查询范围:
all:查询国内+国外
cn:查询国内
abroad:查询国外
不填充时,默认为国内+国外。

调用示例

//请求需要经过URL编码处理。
curl -X GET "https://cdn.api.baishan.com/v2/stat/request/eachDomain?token=xxx\
&domains=example.com,example2.com\
&start_time=2020-06-01%2010:00\
&end_time=2020-06-01%2011:00"

返回示例

json格式

正确示例
{
    "code": 0, //code为0,表示数据返回正常。
    "data": {
        "example.com": {
            "domain": "example.com",
            "data": [
                [
                    1590984900,//时间戳,按照升序排序。
                    15383//请求数的个数
                ],
                [
                    1590985200,
                    17570
                ],
                ...
            ]
        },
        "example2.com": {
            "domain": "example2.com",
            "data": [
                [
                    1590984900,
                    15383
                ],
                [
                    1590985200,
                    17570
                ],
                ...
            ]
        }
        ...
    }
}

错误示例
{
    "code": 400101,
    "message": "domain(life.com) is invalid"
}

响应头部(Response Header)

HTTP/1.0 200 OK
Content-Type: application/json; charset=utf-8
X-Ratelimit-Remaining:100//每分钟剩余请求次数
X-Ratelimit-Limit:100//当前每分钟请求次数上限
X-Ratelimit-Grad: minute//接口调用频率限制粒度(分/小时/天)
X-Retry-After:59//xx秒后重置当前粒度(分/小时/天)请求次数限制
Api-Id: 131277040

http状态码说明

错误状态码说明
404您输入的 URL 错误
401鉴权错误,您的 token 可能是不对的
400请求参数有误
200执行成功,返回请求的数据
5xx请联系值班同事
CopyRight © 2015-2024 BaishanCloud . All Rights Reserved.