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

调用PCAlarmCandidate接口查看过滤项的可选值。

请求说明

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

请求参数

Query

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

Body

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

CommonParams

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

FlexFilterCandidateRequest

参数类型是否必选示例值描述
end_timeInteger1668156081结束时间。
start_timeInteger1668156081开始时间。
filter_nameStringos过滤字段名称。
measure_listArray of FlexMeasure-相关指标列表。

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 FlexFilterCandidateResponseData-返回内容。
errmsgString""错误信息,成功为空。
errnoInteger200错误码,成功为200。

FlexFilterCandidateResponseData

参数类型示例值描述
candidate_listArray of FlexFilterCandidate-候选列表。

FlexFilterCandidate

参数类型示例值描述
labelStringwindows展示值。
valueStringwindows候选值。

请求示例

POST https://open.volcengineapi.com?Action=PCAlarmCandidate&Version=2022-10-28
{
    "common": {
        "aid": 12345,
        "os": "pc",
        "env": "crash",
        "site_type": ""
    },
    "flex_param": {
        "start_time": 1668156081,
        "end_time": 1668156081,
        "measure_list": [
            {
                "type": "monomial",
                "raw_measure_list": [
                    {
                        "measure_name": "\"{\\metric\\:\\pc_flexible.count\\,\\event_dimension\\:\\pc_flexible.event_name\\,\\event_name\\:\\test_service_gyf\\}\"",
                        "filter_list": [
                            {
                                "op": "in",
                                "filter_name": "cpu",
                                "values": [
                                    "intel",
                                    "Qualcomm"
                                ]
                            }
                        ],
                        "event_name": "test_service_gyf"
                    }
                ],
                "name": "崩溃影响用户数",
                "customId": "xe3ejx98"
            }
        ],
        "filter_name": "os"
    }
}

返回示例

{
    "errno": 200,
    "data": {
        "candidate_list": [
            {
                "value": "windows",
                "label": "windows"
            }
        ]
    },
    "errmsg": ""
}

错误码

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