请求URL: stat/bandwidth (GET)
接口请求域名:
cdn.api.baishan.com
接口版本:v2
用于查询加速域名的带宽、流量数据。
数据统计的时间粒度默认为5分钟。接口调用频率限制见响应头部(Response Header)。
公有参数:用户的 token 可向值班同事获取。
参数添加到在url的query部分,例如: ?key1=value1&key2=value2。
参数名 | 数据类型 | 是否必须 | 说明 |
---|---|---|---|
domains | string | 是 | 指定查询的加速域名,最多可一次性查询10个加速域名。 当查询多个加速域名时,返回多个加速域名的汇总数据。 all :返回账号下所有加速域名的汇总数据。 |
start_time | string | 是 | 指定查询起始时间,如: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_time | string | 是 | 指定查询结束时间,如: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天。 |
data_type | string | 否 | 指定数据指标查询:bandwidth :带宽,单位bpstraffic :流量,单位byte不填充时, 默认值为bandwidth。 |
grad | string | 否 | 指定数据统计的时间粒度查询:minute :1分钟粒度minute5 :5分钟粒度hour :小时粒度day :天粒度不填充时,默认为minute5。 |
protocol_type | string | 否 | 指定HTTP协议查询:http :查询http的统计数据https :查询https的统计数据不填充时,默认返回http和https的汇总数据。 |
ip_protocol | string | 否 | 指定IP协议查询:ipv4 :查询ipv4的统计数据ipv6 :查询ipv6的统计数据不填充时,默认返回ipv4和ipv6的汇总数据。 |
query_area | string | 否 | 指定服务地区查询:all (默认值):全球cn : 国内abroad :海外 港澳台及国外地区: vn :越南;sg :新加坡;th :泰国;my :马来西亚;ph :菲律宾;id :印度尼西亚;in :印度;mm :缅甸;la :老挝;kh :柬埔寨;bd :孟加拉国;br :巴西;jp :日本;kr :韩国;pk :巴基斯坦;ru :俄罗斯;it :意大利;ng :尼日利亚;gb :英国;ir :伊朗;bh :巴林;kw :科威特;ca :加拿大;hk :中国香港;mo :中国澳门;tw :中国台湾;不填充时,默认为all。 可以通过【国家及地区列表】接口获取地区代码。 |
//请求需要经过URL编码处理。
curl -X GET "https://cdn.api.baishan.com/v2/stat/bandwidth?token=xxx\
&domains=example.com,example2.com\
&start_time=2020-06-01%2012:16\
&end_time=2020-06-01%2012:30"
json格式
正确示例
{
"code": 0,//code为0时,表示数据返回正常。
"data": [
[
1590984900, //时间戳,按照升序排序。
208706182.29 //返回data_type选择的数据。
],
[
1590985200,
202799878.64
],
[
1590985500,
248881899.04
],
[
1590985800,
242017854.58
]
]
}
错误示例
{
"code": 400101,
"message": "domain(life.com) is invalid"
}
HTTP/1.0 200 OK
Api-Id: 1039
Content-Type: application/json; charset=utf-8
X-Ratelimit-Grad: minute //接口调用频率限制粒度(分/小时/天)
X-Ratelimit-Limit: 300 //当前每分钟请求次数上限
X-Ratelimit-Remaining: 99 //每分钟剩余请求次数
X-Retry-After: 21 //xx秒后重置当前粒度(分/小时/天)请求次数限制
错误状态码 | 说明 |
---|---|
404 | 您输入的 URL 错误 |
401 | 鉴权错误,您的token错误,或者没有开通接口权限 |
400 | 请求参数有误 |
200 | 执行成功,返回请求的数据 |
5xx | 请联系值班同事 |