查询拨测统计数据--云拨测-火山引擎

文档中心

立即注册

导航

查询拨测统计数据

最近更新时间：2024.06.20 18:50:48首次发布时间：2023.10.13 14:33:20

获取即席分析数据

使用限制

节流限制：您每秒最多可以提交 5 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cloud-detect.volcengineapi.com?Action=GetOlapData&Version=2023-08-31

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `GetOlapData`。
Version	String	是	接口版本。当前 API 的版本为 `2023-08-31`。

Body

参数名称	数据类型	是否必选	参数说明	示例
start_time	Long	是	查询开始时间。格式为 Unix 时间戳（秒）。	`1695040266`
end_time	Long	是	查询结束时间。格式为 Unix 时间戳（秒）。	`1695299466`
granularity	String	否	时间分组粒度： `second`：一秒 `ten_minute`：十分钟 `five_minute`：五分钟 `minute`：一分钟 `hour`：一小时 `day`：一天 `week`：一周	`"second"`
filters	Object[]	是	筛选条件。
groups	Object[]	否	分组条件。
measures	Object[]	是	查询指标。
timezone	String	否	时区。格式参见 Time Zone Database。	`"Asia/Shanghai"`
prev	String	否	同环比参数。格式为 `"{n}_{day/hour}"`，其中 `n` 为数值。	`"1_day"`
topn	Object	否	TopN 参数。

返回参数

参数名称	数据类型	参数说明
groups	Object[]	分组数据。
measures	Object[]	指标数据。
prev_measures	Object[]	同环比指标数据。

请求示例

POST https://cloud-detect.volcengineapi.com?Action=GetOlapData&Version=2023-08-31
{
    "timezone": "Asia/Shanghai",
    "granularity": "hour",
    "filters": [
        {
            "key": "target.addr",
            "type": "in",
            "values": [
                "[fdbd:dc01:16::90]",
                "[fdbd:dc01:fe:100a::1]",
                "10.15.63.90"
            ]
        }
    ],
    "groups": [
        {
            "key": "client.province.name"
        }
    ],
    "measures": [
        {
            "key": "success.proportion"
        }
    ],
    "start_time": 1695040266,
    "end_time": 1695299466
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230921203134511034E384BB822811ED",
    "Action": "GetOlapData",
    "Version": "2023-08-31",
    "Service": "cloud_detect",
    "Region": "cn-north-1"
  },
  "Result": [
    {
      "groups": [
        {
          "key": "client.province.name",
          "value": "\"山西\""
        }
      ],
      "measures": [
        {
          "key": "success.proportion",
          "value": "1.0425431069446676"
        }
      ]
    },
    {
      "groups": [
        {
          "key": "client.province.name",
          "value": "\"河北\""
        }
      ],
      "measures": [
        {
          "key": "success.proportion",
          "value": "23.14745390518418"
        }
      ]
    },
    {
      "groups": [
        {
          "key": "client.province.name",
          "value": "\"河南\""
        }
      ],
      "measures": [
        {
          "key": "success.proportion",
          "value": "58.575512148642204"
        }
      ]
    }
  ]
}