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

文档中心

立即注册

导航

MiniProGetFieldKeys

最近更新时间：2024.07.15 15:52:20首次发布时间：2024.04.03 17:37:04

获取筛选条件。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=MiniProGetFieldKeys&Version=2024-03-12

请求参数

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

Query

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

Body

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

common Object of Common 是 - 通用参数。

参数	类型	是否必选	示例值	描述
common	Object of Common	是	`-`	通用参数。
ev_type	String	是	`performance`	模块类型。 performance：性能监控 js_error：js监控 http：请求监控 url_list：页面列表 custom：自定义监控 session：数据探索/session view：数据探索/view js_error：数据探索/js error custom：数据探索/custom event log：数据探索/custom log
filter_conditions	Object of FilterConditions	否	`-`	时间区间。

ev_type

String

是

performance

模块类型。

performance：性能监控
js_error：js监控
http：请求监控
url_list：页面列表
custom：自定义监控
session：数据探索/session
view：数据探索/view
js_error：数据探索/js error
custom：数据探索/custom event
log：数据探索/custom log

filter_conditions Object of FilterConditions 否 - 时间区间。

Common

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。

FilterConditions

参数	类型	是否必选	示例值	描述
type	String	是	`and`	筛选条件类型。 and：children中的条件为“与”关系。 rule（默认）：当前条件为原子条件。
field	String	否	`pid`	条件字段。
op	String	否	`in`	条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。
values	Array of String	否	`["数据探索"]`	条件值，可选值集合由`GetFieldValues`方法获取。
children	Array of FilterConditions	否	`-`	子参数。当type值为`and`时必填。children下还可以继续嵌套，与op、field、values不可以共存。

返回参数

参数	类型	示例值	描述
data	Array of Data	`-`	返回内容。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误吗。0为成功。

Data

参数	类型	示例值	描述
name	String	`pid`	筛选维度。
description	String	`pid`	筛选维度描述。
renderForm	String	`RegexAndNotRegexEqAndNeqSymbol`	筛选维度支持的筛选方式。

请求示例

POST https://open.volcengineapi.com?Action=MiniProGetFieldKeys&Version=2024-03-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
}

错误码

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

应用性能监控全链路版