查询态势感知数据¶

1. 接口描述¶

接口请求路径：POST /prod-api/cdn/layer7/statistic/describeL7MostData

describeL7MostData 用于按指定维度（如 URL、来源 IP、状态码等）查询访问排行数据，支持按请求数或流量排序。一次请求可在 action 中声明多个维度，返回的 data 与 action 顺序一一对应。

仅支持查询最近 500 天内的数据，单次查询时间跨度不超过 40 天；单次最多查询 30 个域名。Token 获取方式见密钥鉴权。

2. 输入参数¶

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
action	是	Array	统计维度列表，不能为空
action.metricName	是	String	统计维度，支持以下值： `ip`：来源 IP `http_user_agent`：客户端 `domain`：域名 `url`：URL `status`：状态码 `request_method`：请求方法 `referer`：Referer `protocol`：协议 `server_port`：端口 `ua_os_name`：操作系统 `hostname`：检测节点 `country_name`：国家/地区 `city_name`：城市 `timezone`：时区 `scheme`：协议场景示例值：`url`
action.pageNo	是	Integer	页码，从 1 开始示例值：`1`
action.pageSize	是	Integer	每页条数示例值：`10`
mostDimension	是	String	排序/汇总维度，支持以下值： `requestCount`：按请求数 `trafficSum`：按流量示例值：`trafficSum`
domains	否	Array of String	域名过滤。空数组或不传表示当前账号全部域名；单次最多 30 个示例值：`[]`
otherFilter	否	Array	附属筛选条件
params.beginTime	是	String	开始时间，格式 `yyyy-MM-dd HH:mm:ss`，仅支持查询最近 500 天示例值：`2024-01-24 00:00:00`
params.endTime	是	String	结束时间，格式 `yyyy-MM-dd HH:mm:ss`，单次跨度不超过 40 天示例值：`2024-01-24 23:59:59`

3. 示例¶

示例1 按 URL 查询流量排行¶

输入示例¶

{
  "params": {
    "beginTime": "2024-01-24 00:00:00",
    "endTime": "2024-01-24 23:59:59"
  },
  "action": [
    {
      "pageSize": 10,
      "pageNo": 1,
      "metricName": "url"
    }
  ],
  "mostDimension": "trafficSum",
  "domains": [],
  "otherFilter": []
}

代码调用¶

请将 {登录域名}、token 替换为实际值。

JavaGo

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class DescribeL7MostDataTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/cdn/layer7/statistic/describeL7MostData";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"params\":{"
                + "\"beginTime\":\"2024-01-24 00:00:00\","
                + "\"endTime\":\"2024-01-24 23:59:59\""
                + "},"
                + "\"action\":[{\"pageSize\":10,\"pageNo\":1,\"metricName\":\"url\"}],"
                + "\"mostDimension\":\"trafficSum\","
                + "\"domains\":[],"
                + "\"otherFilter\":[]"
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/cdn/layer7/statistic/describeL7MostData"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "params": {
    "beginTime": "2024-01-24 00:00:00",
    "endTime": "2024-01-24 23:59:59"
  },
  "action": [
    {"pageSize": 10, "pageNo": 1, "metricName": "url"}
  ],
  "mostDimension": "trafficSum",
  "domains": [],
  "otherFilter": []
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例¶

{
  "msg": "操作成功",
  "code": 200,
  "data": [
    {
      "metricName": "url",
      "data": {
        "total": 1592915833.2,
        "list": [
          {
            "name": "/",
            "value": 4125457504.9
          }
        ],
        "termsCount": 73673
      }
    }
  ]
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`操作成功`
data	Array	指标结果列表，顺序与请求 `action` 一致
data[].metricName	String	统计维度名称，与请求一致
data[].data	Object	排行结果
data[].data.total	Number	汇总总量。`requestCount` 时为请求总数；`trafficSum` 时为流量总和
data[].data.termsCount	Integer	该维度去重后的项数。示例值：`73673`
data[].data.list	Array	排行列表。元素含 `name`（维度值）、`value`（请求数或流量）

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
请选择时间范围	未传 `params` 或缺少 `beginTime` / `endTime`
一次性最多查询30个域名	`domains` 超过 30 个
只能查询最近500天的数据	开始时间超出限制
一次只能查询40天的数据	时间跨度超过 40 天
请输入正确的分页参数	`pageNo` / `pageSize` 缺失或小于 1
查询失败,请确认查询参数是否合法	查询执行失败或参数非法