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

调用PCAlarmMeta接口查看报警类型及对应的指标。

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
commonObject of CommonParams-通用参数。

CommonParams

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

返回参数

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

FlexMetaResponseData

参数类型示例值描述
measure_category_meta_listArray of FlexMeasureCategoryMetaItem-类别以及相关指标列表。

FlexMeasureCategoryMetaItem

参数类型示例值描述

key

String

pc_crash

类型。

  • pc_crash
  • pc_flexible

type

String

simple

类别类型。

  • event:表明是事件选择后需要调用事件相关接口
  • simple:表明为其他的固定的指标
labelStringPC 崩溃监控类别展示名。
measure_meta_listArray of FlexMeasureMetaItem-类型中指标列表,如果不为simple就没有值返回。

FlexMeasureMetaItem

参数类型示例值描述
keyStringmetrics事件类型。

type

String

basic

指标类型。

  • 事件指标:event
  • 其他:basic
labelString影响用户数展示标签。
event_nameStringevent1事件名。
measure_nameStringuser_count指标名称。

请求示例

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

返回示例

{
    "data": {
        "measure_category_meta_list": [
            {
                "label": "PC 崩溃监控",
                "type": "simple",
                "key": "pc_crash",
                "measure_meta_list": [
                    {
                        "label": "影响用户数",
                        "key": "metrics",
                        "type": "basic",
                        "event_name": "event1",
                        "measure_name": "user_count"
                    }
                ]
            }
        ]
    },
    "errmsg": "",
    "errno": 200
}

错误码

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