GetFieldKeys--应用性能监控全链路版-火山引擎

文档中心

导航

GetFieldKeys

最近更新时间：2024.07.12 17:21:37首次发布时间：2022.11.01 11:26:00

获取筛选条件。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=GetFieldKeys&Version=2022-10-12

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

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetFieldKeys`	接口名称。当前 API 的名称为 `GetFieldKeys`。
Version	String	是	`2022-10-12`	接口版本。当前 API 的版本为 `2022-10-12`。

Body

参数类型是否必选示例值描述

common Object of CommonParams 是 - 通用参数。

参数	类型	是否必选	示例值	描述
common	Object of CommonParams	是	`-`	通用参数。
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
filter_conditions	Object of FilterCondition	否	`-`	筛选条件。

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

filter_conditions Object of FilterCondition 否 - 筛选条件。

CommonParams

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。
site_type	String	是	`web`	站点类型。
env	String	是	`online`	环境，填""时为全部。
os	String	否	`webpro`	服务类型，可选值为webpro，app，minipro。
user	String	否	`test_user`	用户名。

FilterCondition

参数	类型	是否必选	示例值	描述
type	String	是	`and`	筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。
field	String	否	`pid`	条件字段key，可选值集合由`GetFieldKeys`方法获取。
op	String	否	`in`	条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。
groupKey	String	否	`context`	map类型字段key，可选值集合由`GetFieldKeys`方法获取。
values	Array of String	否	`[数据探索]`	条件值，可选值集合由`GetFieldValues`方法获取。
children	Array of FilterCondition	否	`-`	如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。

返回参数

参数	类型	示例值	描述
data	Array of FieldKeysResp	`-`	返回内容。
error_msg	String	`success`	错误消息。
error_no	Integer	`500`	错误码。0为成功。

FieldKeysResp

参数	类型	示例值	描述
name	String	`pid`	字段名称。
isDefault	Boolean	`true`	是否默认。
renderForm	String	`-`	展现形式。
description	String	`-`	字段描述。

请求示例

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
}

错误码

本接口无特有的错误码。更多信息请参见错误码。

应用性能监控全链路版