You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /
  • 应用性能监控全链路版

MiniProAlarmMetricsCandidate

最近更新时间：2024.05.08 17:48:42

首次发布时间：2024.04.03 17:37:04

我的收藏

调用MiniProAlarmMetricsCandidate获取指定报警指标下具体筛选条件的可选值。

请求说明

  • 请求方式：POST
  • 请求地址：?Action=MiniProAlarmMetricsCandidate&Version=2024-03-12

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是MiniProAlarmMetricsCandidate接口名称。当前 API 的名称为 MiniProAlarmMetricsCandidate。
VersionString是2024-03-12接口版本。当前 API 的版本为 2024-03-12。

Body

参数类型是否必选示例值描述
commonObject of Common是-通用参数。
flex_paramObject of Flex_param是-指定报警指标和筛选条件。

Common

参数类型是否必选示例值描述
aidLong是12345应用ID。
osString否minipro服务类型。取值支持app、webpro、minipro。

Flex_param

参数类型是否必选示例值描述
measure_listArray of Measure_list否-报警指标列表。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。
filter_nameString否browser_brand筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。

Measure_list

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

type

String

否

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of Raw_measure_list否-所有指标的集合。

formula

String

否

-

指标四则运算公式。
当指标类型为复合指标polynomial时选填。

name

String

否

PV

指标名。

  • 当指标为普通指标时，为指标名。
  • 当指标为复合指标时，为自定义指标名。

Raw_measure_list

参数类型是否必选示例值描述
measure_nameString否pv_uv.count简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。
filter_listArray of Filter_list否-筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_nameString否-自定义事件key。当指标为自定义事件指标时是。

Filter_list

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

op

String

否

in

筛选条件符号。

  • in
  • not_in
  • regex
  • not_regex
filter_nameString否browser_brand筛选字段。调用GetAlarmEventMetaMetric接口查看取值。
valuesArray of String否["Chrome"]筛选条件值。

返回参数

参数类型示例值描述
dataObject of Data-返回数据。
error_msgString-错误信息。
error_noInteger0错误码。0为成功。

Data

参数类型示例值描述
candidate_listArray of Candidate_list-筛选条件可选值列表。

Candidate_list

参数类型示例值描述
labelStringChrome筛选条件。
valueStringChrome筛选条件的可选值。

请求示例

POST ?Action=MiniProAlarmMetricsCandidate&Version=2024-03-12
{
    "flex_param": {
        "filter_name": "browser_brand",
        "measure_list": [
            {
                "type": "monomial",
                "raw_measure_list": [
                    {
                        "measure_name": "pv_uv.count",
                        "event_name": "",
                        "filter_list": [
                            {
                                "filter_name": "browser_brand",
                                "values": [
                                    "Chrome"
                                ],
                                "op": "in"
                            }
                        ]
                    }
                ],
                "formula": "",
                "name": "PV"
            }
        ]
    },
    "common": {
        "aid": 12345,
        "os": "minipro"
    }
}

返回示例

{
    "err_detail":"",
    "data":{
        "candidate_list":[
            {
                "label":"Chrome",
                "value":"Chrome"
            },
            {
                "label":"Chrome Mobile iOS",
                "value":"Chrome Mobile iOS"
            }
        ]
    },
    "error_msg":"",
    "error_no":0
}