You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
合作与生态
支持与服务
开发者
了解我们
导航
应用性能监控全链路版
  • 文档首页
    • /
  • 应用性能监控全链路版

GetFieldKeys

更新时间：2023.04.11 16:11:01

我的收藏

调用GetFieldKeys接口获取筛选条件。

使用说明

  • 接口名称：GetFieldKeys
  • 请求方式：POST
  • 接口地址：/?Action=GetFieldKeys&Version=2022-10-12

请求参数

Query

参数

类型

是否必选

示例值

描述

Action

String

是

GetFieldKeys

请求名称。

Version

String

是

2022-10-12

请求版本。

ServiceName : apmplus_openapi
Region : cn-beijing 
X-App-Ids : xxx
Content-Type : application/json

Body

参数

类型

是否必填

示例值

说明

ev_type

string

是

performance

模块类型。

  • performance：性能监控
  • js_error：js监控
  • http：请求监控
  • resource：静态资源监控
  • url_list：页面列表
  • action：action列表
  • custom：自定义监控
  • blank_screen：白屏监控
  • session：数据探索/session
  • view：数据探索/view
  • action：数据探索/action
  • js_error：数据探索/js error
  • http：数据探索/request
  • resource：数据探索/resource
  • resource_error：数据探索/resource error
  • custom：数据探索/custom event
  • log：数据探索/custom log
  • performance_longtask：数据探索/long task
  • blank_screen：数据探索/blank screen

common

object of common

是

-

通用参数。

filter_conditions

object of time_filter

是

-

时间区间。

common

参数

类型

是否必填

示例值

说明

aid

int64

是

12345

应用ID。

filter_conditions

参数

类型

是否必填

示例值

说明

type

string

否

and

筛选条件类型。

  • and：children中的条件为与关系。
  • rule（默认）：当前条件为原子条件。

children

object of common

否

-

子参数。当type值为and时必填。

children

参数

类型

是否必填

示例值

说明

op

string

是

in

条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。

field

string

是

pid

条件字段。

values

[]string

是

["数据探索"]

条件值，可选值集合由GetFieldValues方法获取。

返回参数

参数

类型

示例值

说明

err_detail

int32

-

错误详情。

data

object of data

-

返回内容。

error_msg

string

-

错误信息。

error_no

int

0

错误码。0为成功。

data

参数

类型

示例值

说明

name

string

pid

筛选维度。

description

string

pid

筛选维度描述。

renderForm

string

RegexAndNotRegexEqAndNeqSymbol

筛选维度支持的筛选方式。

请求示例 

POST https://open.volcengineapi.com/?Action=GetFieldKeys&Version=2022-10-12

{
    "ev_type": "performance",
    "common": {
        "aid": 12345 
    },
    "filter_conditions": { 
        "type": "and", 
        "children": [ 
            {
                "op": "in", 
                "field": "pid",
                "values": [
                    "数据探索"
                ]
            }
        ]
    },
}

返回示例 

{
    "err_detail":"",
    "data":[
        {
            "name":"pid",
            "description":"pid",
            "renderForm":"RegexAndNotRegexEqAndNeqSymbol",
            "isDefault":false
        }
    ],
    "error_msg":"",
    "error_no":0
}