统计接口
更新时间:2021-01-25
接口
本接口用于查询用户或域名的统计指标信息。
Method | Path | 说明 |
---|---|---|
POST | /v2/dsa/stat/query | 所有统计数据的路径,不同的统计指标由post参数中的metric指定。 |
默认接口请求频率限制:30次/秒。
默认请求体(Request Body)
所有metric支持的参数以此进行扩展。
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
metric | 必选 | String | 指定flow, uploadflow, pv等 |
endTime | 可选 | Timestamp | 查询的时间范围结束值,默认为当前时间。时间跨度最长90天 UTC时间 |
startTime | 可选 | Timestamp | 查询的时间范围起始值,默认为endTime前推24小时 UTC时间 |
period | 可选 | Long | 查询结果的粒度,单位秒,可选值为60,300,3600,86400;默认为300,uv 默认3600(选60s的时间粒度时建议startTime和endTime区间跨度建议选择0.5到1h,否则可能会因为数据量太大无法正常返回) |
key_type | 可选 | Long | 标识key的内容,0=>域名,1=>用户id,2=>tag,默认0 |
key | 可选 | list<String> | 域名或用户Id或Tag |
groupBy | 可选 | String | 返回结果聚合粒度,key => 根据key聚合, 空 => 返回整体结果 |
默认响应体(Response Body)
所有metric的响应结果以此扩展。
参数 | 类型 | 说明 |
---|---|---|
status | String | 正常返回的时候为"ok" |
details | list<Details> | list类型 |
count | Long | list的长度 |
Details 内容
参数 | 类型 | 说明 |
---|---|---|
timestamp | Timestamp | 时间点 UTC时间 |
key | String | 聚合粒度(groupBy):key => key,其他 => total |
... | Object | 扩展字段,metric对应的统计指标 |
pv/qps相关接口
pv/qps查询
metric:pv
请求体扩展字段:
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
level | 可选 | String | 查询边缘节点或者中心节点pv。可填写"all"或"edge"或者"internal",默认为“all” |
响应体扩展字段:
参数 | 类型 | 说明 |
---|---|---|
pv | Long | 统计时间段内的请求量 |
qps | Long | 统计时间段内的平均qps |
请求示例
POST /v2/dsa/stat/query HTTP/1.1
Host: cdn.baidubce.com
{"metric":"pv","startTime":"2019-03-20T06:00:00Z","endTime":"2019-03-20T06:10:00Z","period":300,"key_type":0,"key":["cdaa.wonter.net"],"groupBy":"key","level":"all"}
返回示例
HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
"status": "ok",
"details": [
{"pv": 2145,"qps": 7,"timestamp": "2019-03-20T06:00:00Z","key": "cdaa.wonter.net"},
{"pv": 2950,"qps": 9,"timestamp": "2019-03-20T06:05:00Z","key": "cdaa.wonter.net"}
],
"count": 2
}
流量带宽接口
查询流量、带宽
metric: flow 下行流量
metric: uploadflow 上行流量
请求体扩展字段:
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
level | 可选 | String | 查询边缘节点或者中心节点带宽。可填写"all"或"edge"或"internal",默认为"all" |
响应体扩展字段:
参数 | 类型 | 说明 |
---|---|---|
flow | Long | 统计时间段内的传输字节数 |
bps | Long | 统计时间段内的平均bps |
请求示例
POST /v2/dsa/stat/query HTTP/1.1
Host: cdn.baidubce.com
{"metric":"flow","startTime":"2019-03-20T06:00:00Z","endTime":"2019-03-20T06:10:00Z","period":300,"key_type":0,"key":["cdaa.wonter.net"],"groupBy":"key","level":"all"}
返回示例
HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json;utf-8
x-bce-request-id: 81d0b05f-5ad4-1f22-8068-d5c9de60a1d7
Server: BCE-CDN
{
"status": "ok",
"details": [
{"flow": 88186275,"bps": 2351634,"timestamp": "2019-03-20T06:00:00Z","key": "cdaa.wonter.net"},
{"flow": 90383520,"bps": 2410227,"timestamp": "2019-03-20T06:05:00Z","key": "cdaa.wonter.net"}
],
"count": 2
}