You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
通用
GetFieldKeys
复制全文
下载 pdf
GetFieldKeys
获取筛选条件。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetFieldKeys&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetFieldKeys​
接口名称。当前 API 的名称为 GetFieldKeys。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
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​
否​
-​
筛选条件。​
​
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不能同时存在。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetFieldKeys&Version=2022-10-12​
{​
"ev_type": "performance",​
"common": {​
"aid": 12345 ​
},​
"filter_conditions": { ​
"type": "and", ​
"children": [ ​
{​
"op": "in", ​
"field": "pid",​
"values": [​
"data explore"​
]​
}​
]​
}​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
Array of FieldKeysResp​
-​
返回内容。​
error_msg​
String​
success​
错误消息。​
error_no​
Integer​
500​
错误码。0为成功。​
​
FieldKeysResp​
​
参数​
类型​
示例值​
描述​
name​
String​
pid​
字段名称。​
isDefault​
Boolean​
true​
是否默认。​
renderForm​
String​
-​
展现形式。​
description​
String​
-​
字段描述。​
​
返回示例​
​
{​
"err_detail":"",​
"data":[​
{​
"name":"pid",​
"description":"pid",​
"renderForm":"RegexAndNotRegexEqAndNeqSymbol",​
"isDefault":false​
}​
],​
"error_msg":"",​
"error_no":0​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:30
这个页面对您有帮助吗?
有用
有用
无用
无用