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

MiniProAlarmMetricsCandidate

最近更新时间：2024.04.17 17:39:50

首次发布时间：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

参数

类型

是否必选

示例值

描述

Action

String

是

MiniProAlarmMetricsCandidate

接口名称。当前 API 的名称为 MiniProAlarmMetricsCandidate。

Version

String

是

2024-03-12

接口版本。当前 API 的版本为 2024-03-12。

Body

参数

类型

是否必选

示例值

描述

common

Object of Common

是

-

通用参数。

flex_param

Object of Flex_param

是

-

指定报警指标和筛选条件。

Common

参数

类型

是否必选

示例值

描述

aid

Long

是

12345

应用ID。

os

String

否

minipro

服务类型。取值支持app、webpro、minipro。

Flex_param

参数

类型

是否必选

示例值

描述

measure_list

Array of Measure_list

否

-

报警指标列表。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。

filter_name

String

否

browser_brand

筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。

Measure_list

参数

类型

是否必选

示例值

描述

type

String

否

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标

raw_measure_list

Array of Raw_measure_list

否

-

所有指标的集合。

formula

String

否

-

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

name

String

否

PV

指标名。

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

Raw_measure_list

参数

类型

是否必选

示例值

描述

measure_name

String

否

pv_uv.count

简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。

filter_list

Array of Filter_list

否

-

筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。

event_name

String

否

-

自定义事件key。当指标为自定义事件指标时是。

Filter_list

参数

类型

是否必选

示例值

描述

op

String

否

in

筛选条件符号。

  • in
  • not_in
  • regex
  • not_regex

filter_name

String

否

browser_brand

筛选字段。调用GetAlarmEventMetaMetric接口查看取值。

values

Array of String

否

["Chrome"]

筛选条件值。

返回参数

参数

类型

示例值

描述

data

Object of Data

-

返回数据。

error_msg

String

-

错误信息。

error_no

Integer

0

错误码。0为成功。

Data

参数

类型

示例值

描述

candidate_list

Array of Candidate_list

-

筛选条件可选值列表。

Candidate_list

参数

类型

示例值

描述

label

String

Chrome

筛选条件。

value

String

Chrome

筛选条件的可选值。

示例

请求示例

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
}