You need to enable JavaScript to run this app.
导航
PCAlarmMeasureRelatedMeta
最近更新时间:2024.06.18 17:13:10首次发布时间:2022.11.15 20:38:48

调用PCAlarmMeasureRelatedMeta接口获取指定事件类型下的可用分组和过滤项列表。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=PCAlarmMeasureRelatedMeta&Version=2022-10-28
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json

请求参数

Query

参数类型是否必选示例值描述
ActionStringPCAlarmMeasureRelatedMeta接口名称。当前 API 的名称为 PCAlarmMeasureRelatedMeta
VersionString2022-10-28接口版本。当前 API 的版本为 2022-10-28

Body

参数类型是否必选示例值描述
commonObject of CommonParams-通用参数。
measureObject of FlexMeasure-指标集合。

CommonParams

参数类型是否必选示例值描述
osStringpc系统。
aidLong12345App ID。
envStringcrash环境信息。

FlexMeasure

参数类型是否必选示例值描述
nameString崩溃影响用户数指标名称。

type

String

monomial

指标类型。

  • monomial
  • polynomial
customIdStringxe3ejx98前端用于还原页面。
raw_measure_listArray of FlexRawMeasure-具体查询指标。

FlexRawMeasure

参数类型是否必选示例值描述
event_nameStringtest_service_gyf前端传了此参数, 后端没有用到。但是还原图表的时候是从这个字段读的事件名。
filter_listArray of FlexFilter-过滤条件。
measure_nameString"{\"metric\":\"pc_flexible.count\",\"event_dimension\":\"pc_flexible.event_name\",\"event_name\":\"test_service_gyf\"}"具体的指标计算值。

FlexFilter

参数类型是否必选示例值描述
opStringin过滤方式。
valuesArray of String["intel", "Qualcomm"]过滤值。
filter_nameStringcpu用于表明filter的哪个维度。

返回参数

参数类型示例值描述
dataObject of AlarmMeasureRelatedMeta-返回内容。
errmsgString""错误信息,成功为空。
errnoInteger200错误码,成功为200。

AlarmMeasureRelatedMeta

参数类型示例值描述
group_meta_listArray of FlexGroupByMeta-分组选项。
filter_meta_listArray of FlexFilterMeta-过滤选项。

FlexGroupByMeta

参数类型示例值描述
labelStringname展示名称。
group_by_nameStringos分组字段。
related_measure_nameArray of String["event1"]相关指标名称。

FlexFilterMeta

参数类型示例值描述
labelStringosVersion展示名。
filter_nameStringos_version过滤名。

filter_type

String

string

过滤方式。

  • number
  • string
  • regex

filter_name_type

Integer

0

过滤值类型

  • 0:字段
  • 1:计算

请求示例

POST https://open.volcengineapi.com?Action=PCAlarmMeasureRelatedMeta&Version=2022-10-28
{
    "common": {
        "aid": 12345,
        "os": "pc",
        "site_type": "",
        "env": "crash"
    }
}

返回示例

{
    "errno": 200,
    "data": {
        "filter_meta_list": [
            {
                "label": "osVersion",
                "filter_name": "os_version",
                "filter_type": "string"
            }
        ],
        "group_meta_list": [
            {
                "group_by_name": "os",
                "related_measure_name": [
                    "event1"
                ],
                "label": "name"
            }
        ]
    },
    "errmsg": ""
}

错误码

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