Skip to content

Authentication

Data Statistics Interface

POST Query Access Monitoring Data statistics:access:query

POST /prod-apicdn/layer7/statistic/v2/describeL7Data

Body Request Parameters

{
  "interval": "1m",
  "params": {
    "beginTime": "2025-04-09 00:00:00",
    "endTime": "2025-04-09 23:59:59"
  },
  "action": [
    {
      "metricName": "trafficTrend"
    },
    {
      "metricName": "bandwidthTrend"
    },
    {
      "metricName": "requestTrend"
    },
    {
      "metricName": "statusCodeTrend"
    },
    {
      "metricName": "requestTimeTrend"
    },
    {
      "pageSize": 10,
      "pageNo": 1,
      "metricName": "trafficRank"
    },
    {
      "pageSize": 10,
      "pageNo": 1,
      "metricName": "requestRank"
    }
  ],
  "domains": []
}

Request Parameters

Name Location Type Required Chinese Name Description
Authorization header string No none
body body object No none
» action body [object] Yes none
»» metricName body string No Data Name metricName：“trafficTrend（Traffic Statistics Chart）”
»» pageNo body integer(int32) No Current Page Number none
»» pageSize body integer(int32) No Items Per Page none
» domains body [string] Yes Domain none
» interval body string Yes Statistics Granularity 1m：1 minute 5m：5 minute 1h：1 hour 1d：1 day
» params body object Yes none
»» beginTime body string Yes Start Time none
»» endTime body string Yes End Time none

Detailed Description

»» metricName: metricName：“trafficTrend（Traffic Statistics Chart）” metricName: "trafficRank (Traffic Data Overview)" metricName: "bandwidthTrend (Bandwidth Statistics Chart)" metricName: "requestTrend (Request Count Statistics Chart)" metricName: "requestRank (Request Count Data Overview)" metricName: "statusCodeTrend (Status Code Statistics Chart)" metricName: "statusCodeRank (Status Code Data Overview)" metricName: "requestTimeTrend (Average Request Duration Statistics Chart)"

Response Example

{
  "msg": "Success",
  "code": 200,
  "data": [
    {
      "metricName": "trafficTrend",
      "objectArrayListMap": {
        "upstreamBytesSent": [],
        "totalBytesSent": [],
        "bytesSent": []
      },
      "totalMap": {
        "upstreamBytesSent": 0,
        "totalBytesSent": 0,
        "bytesSent": 0
      }
    },
    {
      "metricName": "trafficRank",
      "list": [],
      "total": 0
    }
  ]
}

{
  "msg": "Success",
  "code": 200,
  "data": [
    {
      "metricName": "trafficTrend",
      "objectArrayListMap": {
        "upstreamBytesSent": [],
        "totalBytesSent": [],
        "bytesSent": []
      },
      "totalMap": {
        "upstreamBytesSent": 0,
        "totalBytesSent": 0,
        "bytesSent": 0
      }
    },
    {
      "metricName": "bandwidthTrend",
      "objectArrayListMap": {
        "upstreamBytesSent": [],
        "totalBytesSent": [],
        "bytesSent": []
      },
      "maxMap": {
        "upstreamBytesSent": 0,
        "totalBytesSent": 0,
        "bytesSent95Peak": 0,
        "bytesSent": 0,
        "totalBytesSent95Peak": 0,
        "upstreamBytesSent95Peak": 0
      }
    },
    {
      "metricName": "requestTrend",
      "objectArrayListMap": {
        "requestCounter": []
      },
      "totalMap": {
        "requestCounter": 0
      }
    },
    {
      "metricName": "statusCodeTrend",
      "objectArrayListMap": {
        "list5xx": [],
        "list4xx": [],
        "list3xx": [],
        "list2xx": [],
        "list1xx": []
      },
      "totalMap": {
        "1xx": 0,
        "2xx": 0,
        "3xx": 0,
        "4xx": 0,
        "5xx": 0
      }
    },
    {
      "metricName": "requestTimeTrend",
      "objectArrayListMap": {
        "requestTime": []
      }
    },
    {
      "metricName": "trafficRank",
      "list": [],
      "total": 0
    },
    {
      "metricName": "requestRank",
      "list": [],
      "total": 0
    }
  ]
}

201 Response

{}

Response Results

Status Code Meaning Description Data Model
200 OK none Inline
201 Created none Inline
401 Unauthorized none Inline
403 Forbidden none Inline
404 Not Found none Inline

Response Data Structure

Status Code 200

Name Type Required Constraints Chinese Name Description
» msg string true none none
» code integer true none none
» data [object] true none none
»» metricName string true none Data Name metricName：“trafficTrend（Traffic Statistics Chart）”
metricName：“trafficRank（Traffic Data Overview）”
metricName：“bandwidthTrend（Bandwidth Statistics Chart）”
metricName：“requestTrend（Request Count Statistics Chart）”
metricName：“requestRank（Request Count Data Overview）”
metricName：“statusCodeTrend（Status Code Statistics Chart）”
metricName：“statusCodeRank（Status Code Data Overview）”
metricName：“requestTimeTrend（Average Request Duration Statistics Chart）”
»» objectArrayListMap object true none Statistics Chart none
»»» upstreamBytesSent [string] false none Upstream Statistics Chart none
»»» totalBytesSent [string] false none Total Statistics Chart none
»»» bytesSent [string] false none Downstream Statistics Chart none
»»» requestCounter [string] false none Total Request Count Statistics Chart none
»»» list5xx [string] false none 5xx Statistics Chart none
»»» list4xx [string] false none 4xx Statistics Chart none
»»» list3xx [string] false none 3xx Statistics Chart none
»»» list2xx [string] false none 2xx Statistics Chart none
»»» list1xx [string] false none 1xx Statistics Chart none
»»» requestTime [string] true none Average Request Duration Statistics Chart none
»» totalMap object true none Statistics Data none
»»» upstreamBytesSent integer false none Upstream Quantity none
»»» totalBytesSent integer false none Total Quantit none
»»» bytesSent integer false none Downstream Quantity none
»»» requestCounter integer false none Total Request Count none
»»» 1xx integer true none 1xx none
»»» 2xx integer true none 2xx none
»»» 3xx integer true none 3xx none
»»» 4xx integer true none 4xx none
»»» 5xx integer true none 5xx none
»» maxMap object false none none
»»» upstreamBytesSent integer true none Upstream Quantity none
»»» totalBytesSent integer true none Total Quantity none
»»» bytesSent95Peak integer true none Downstream 95 Quantity none
»»» bytesSent integer true none Downstream Quantity none
»»» totalBytesSent95Peak integer true none Total 95 Quantity none
»»» upstreamBytesSent95Peak integer true none Upstream 95 Quantity none
»» list [string] true none none
»» total integer true none none

Data Model

Action

{
  "metricName": "string",
  "pageNo": 0,
  "pageSize": 0
}

Action

Properties

Name Type Required Constraints Chinese Name Description
metricName string false none none
pageNo integer(int32) false none Current Page Number none
pageSize integer(int32) false none Items Per Page none

StatisticOtherFilterVO

{
  "oneVal": "string",
  "threeVal": ["string"],
  "threeVals": ["string"],
  "twoVal": "string"
}

StatisticOtherFilterVO

Properties

Name Type Required Constraints Chinese Name Description
oneVal string false none none
threeVal [string] false none none
threeVals [string] false none none
twoVal string false none none

L7QueryStatisticV2VO

{
  "action": [
    {
      "metricName": "string",
      "pageNo": 0,
      "pageSize": 0
    }
  ],
  "domains": ["string"],
  "interval": "string",
  "mostDimension": "string",
  "otherFilter": [
    {
      "oneVal": "string",
      "threeVal": ["string"],
      "threeVals": ["string"],
      "twoVal": "string"
    }
  ],
  "pageNum": 0,
  "pageSize": 0,
  "params": {
    "beginTime": "string",
    "endTime": "string"
  },
  "searchHeader": {},
  "terminal": "string",
  "userId": 0
}

L7QueryStatisticV2VO

Properties

Name Type Required Constraints Chinese Name Description
action [Action] true none none
domains [string] true none Domain none
interval string true none Statistics Granularity 1m：1 minute 5m：5 minute 1h：1 hour 1d：1 day
mostDimension string false none none
otherFilter [StatisticOtherFilterVO] false none none
pageNum integer(int32) false none none
pageSize integer(int32) false none none
params object true none none
» beginTime string true none Start Time none
» endTime string true none End Time none
searchHeader object false none none
terminal string false none none
userId integer(int64) false none none