查询URL排行统计数据--全站加速-火山引擎

文档中心

立即注册

导航

查询URL排行统计数据

最近更新时间：2024.04.16 16:10:01首次发布时间：2021.12.27 17:16:07

API说明

API名称：DescribeTopURLs 。
API域名：open.volcengineapi.com。
API描述：统计URL的排行数据。

URI参数

公共参数

Action和Version需要放在请求 URL 后方参数中。

参数名称	是否必选	参数类型	参数说明
Action	是	String	API 名称，该参数的取值是 DescribeTopURLs 。
Version	是	String	API 版本，该参数的取值是 2021-04-01 。

请求正文

参数名称	是否必选	参数类型	参数说明	示例值
StartTime	是	String	查询起始时间。	`2021-01-01 00:00:00`
EndTime	是	String	查询结束时间。	`2021-01-01 23:59:59`
Sort	是	String	指定排序指标，可指定值： `traffic`：流量。 `bandwidth`：峰值带宽。 `request`: 请求数。 `QPS`: 峰值 QPS 。	`request`
Limit	否	Integer	域名获取数量限制，默认为20，取值支持1~100 。	`20`
ProjectName	否	[ ]String	指定查询域名所属的项目，为空代表查询当前用户所有项目。	`["TEST"]`
Domain	否	String	指定查询域名，不填默认全选。	`test.com`
StatusCode	否	[ ]String	指定查询状态码，2xx,3xx,4xx,5xx。	`2xx`

响应正文

参数名称	参数类型	参数说明	示例
TopURLs	TopURL	URL排名列表。	`-`

调用示例

请求示例

POST https://open.volcengineapi.com/?Version=2021-04-01&Action=DescribeTopURLs&<其他公共请求参数>
{
   "StartTime":"2019-12-13 00:00:00",
   "EndTime":"2019-12-13 01:00:00",
   "Sort":"request"
}

响应示例

{
   "ResponseMetadata": {
      "RequestId": "2021092620401201022508421706B81F53",
      "Action": "DescribeTopURLs",
      "Version": "2021-04-01",
      "Service": "dcdn",
      "Region": "cn-south-1"
   },
   "Result": {
      "TopURLs": [
	 {
		"URL": "/v1/",
		"Rank": 1,
		"Request":3,
		"Traffic":3,
		"Bandwidth":3,
		"QPS":3
	 },
	 {
		"URL": "/v2/",
		"Rank": 2,
		"Request":3,
		"Traffic":3,
		"Bandwidth":3,
		"QPS":3
	 }
      ]
   }
}