Documentation¶

Resource Monitoring Interface¶

POST Query Access Monitoring Data¶

POST /prod-api/cdn/layer7/statistic/describeL7Data

Body Request Parameters

{
  "interval": "1m",
  "domains": [],
  "terminal": "cdn",
  "params": {
    "beginTime": "2023-12-26 00:00:00",
    "endTime": "2024-01-25 23:59:59"
  },
  "action": [
    {
      "metricName": "trafficTrend"
    }
  ]
}

Request Parameters¶

Name	Location	Type	Required	Chinese Name	Description
Authorization	header	string	No		none
body	body	object	No		none
» action	body	[Action]	No		metricName: "trafficTrend (Traffic Chart)"
»» Action	body	Action	No	Action	none
»»» metricName	body	string	No		none
»»» pageNo	body	integer(int32)	No		none
»»» pageSize	body	integer(int32)	No		none
» domains	body	[string]	No		none
» interval	body	string	Yes	Statistics Granularity	1m：1 minute
» mostDimension	body	string	Yes		none
» otherFilter	body	[StatisticOtherFilterVO]	No		none
»» StatisticOtherFilterVO	body	StatisticOtherFilterVO	No	StatisticOtherFilterVO	none
»»» oneVal	body	string	No		none
»»» threeVal	body	[string]	No		none
»»» threeVals	body	[string]	No		none
»»» twoVal	body	string	No		none
» pageNum	body	integer(int32)	Yes	Current Page Number	none
» pageSize	body	integer(int32)	Yes	Items Per Page	none
» params	body	object	No		none
»» beginTime	body	string	Yes	Start Time	none
»» endTime	body	string	Yes	End Time	none
» userId	body	integer(int64)	No		none
» terminal	body	string	Yes		cdn：访问数据

详细 Description¶

» action: metricName: "trafficTrend (Traffic Chart)" metricName: "trafficRank (Traffic Data Display)" metricName: "totalTraffic (Traffic Overview)" metricName: "bandwidthTrend (Bandwidth Chart)" metricName: "bandwidthRank (Bandwidth Data Display)" metricName: "totalRequest (Total Requests)" metricName: "requestTrend (Request Count Chart)" metricName: "requestRank (Request Count Data Display)"

» interval: 1m：1 minute 5m：5 minute 1h：1 hour 1d：1 day

» terminal: cdn: access data source: origin data

Response Example

{
  "msg": "Operation successful",
  "code": 200,
  "data": [
    {
      "metricName": "trafficTrend",
      "data": {
        "trend": [
          [1703520060000, 4073165.8],
          [1703520120000, 1942074.2]
        ]
      }
    }
  ]
}

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
»» cnd	object	true	none		none
»»» totalTraffic	object	true	none		none
»»»» value	string	true	none	Access Traffic	none
»» source	object	true	none		none
»»» totalTraffic	object	true	none		none
»»»» value	string	true	none	Origin Traffic	none
» bandwidth95Peak	string	true	none	95^th Peak Bandwidth	none
» totalRequest	object	true	none		none
»» value	string	true	none	Total Requests	none
» topBandwidth	object	true	none		none
»» value	string	true	none	Bandwidth Peak 值	none
»» date	string	true	none	Peak Time	none

POST Query Advanced Monitoring Data¶

POST /prod-api/cdn/layer7/statistic/describeL7MostData

Body Request Parameters

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

Request Parameters¶

Name	Location	Type	Required	Chinese Name	Description
Authorization	header	string	No		none
body	body	object	No		none
» action	body	[Action]	No		metricName: "ip (Source IP)"
»» Action	body	Action	No	Action	none
»»» metricName	body	string	No		none
»»» pageNo	body	integer(int32)	No		none
»»» pageSize	body	integer(int32)	No		none
» domains	body	[string]	No		none
» interval	body	string	Yes	Statistics Granularity	1m：1 minute
» pageNum	body	integer(int32)	Yes	Current Page Number	none
» pageSize	body	integer(int32)	Yes	Items Per Page	none
» params	body	object	No		none
»» beginTime	body	string	Yes	Start Time	none
»» endTime	body	string	Yes	End Time	none
» terminal	body	string	No		cnd：access data
» userId	body	integer(int64)	No		none
» mostDimension	body	string	Yes		requestCount: request count
» otherFilter	body	[string]	Yes		none

详细 Description¶

» action: metricName：“ip（Source IP）” metricName: "http_user_agent (Client)" metricName: "domain (Domain)" metricName: "url (URL)" metricName: "status (Status Code)" metricName: "request_method (Request Method)" metricName: "referer (Referer)" metricName: "protocol (Protocol)" metricName: "server_port (Port)" metricName: "ua_os_name (Operating System)" metricName: "hostname (Detection Node)" metricName: "country_name (Country/Region)" metricName: "city_name (City)" metricName: "timezone (Timezone)" metricName: "scheme (Scenario)"

» interval: 1m：1 minute 5m：5 minute 1h：1 hour 1d：1 day

» terminal: cnd：access data source：origin data

» mostDimension: requestCount: request count trafficSum: traffic

Response Example

{
  "msg": "Operation successful",
  "code": 200,
  "data": [
    {
      "metricName": "url",
      "data": {
        "total": 1592915833.2,
        "list": [
          {
            "name": "/",
            "value": 4125457504.9
          }
        ],
        "termsCount": 73673
      }
    }
  ]
}

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	Description
» msg	string	true	none	none
» code	integer	true	none	none
» data	object	true	none	none

Data Model¶

Action

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

Action

Properties¶

Name	Type	Required	Constraints	Description
metricName	string	false	none	none
pageNo	integer(int32)	false	none	none
pageSize	integer(int32)	false	none	none

L7QueryStatisticVO

{
  "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"
  },
  "terminal": "string",
  "userId": 0
}

L7QueryStatisticVO

Properties¶

Name	Type	Required	Constraints	Chinese Name	Description
action	[Action]	true	none		none
domains	[string]	false	none		none
interval	string	true	none	Statistics Granularity	1m：1 minute 5m：5 minute 1h：1 hour 1d：1 day
mostDimension	string	true	none		none
otherFilter	[StatisticOtherFilterVO]	false	none		none
pageNum	integer(int32)	true	none	Current Page Number	none
pageSize	integer(int32)	true	none	Items Per Page	none
params	object	false	none		none
» beginTime	string	true	none	Start Time	none
» endTime	string	true	none	End Time	none
terminal	string	false	none		cnd: access data source: origin data
userId	integer(int64)	false	none		none

StatisticOtherFilterVO

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

StatisticOtherFilterVO

Properties¶

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