查看过滤项的可选值。
请求说明
- 请求方式：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
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | PCAlarmCandidate | 接口名称。当前 API 的名称为 PCAlarmCandidate。 |
| Version | String | 是 | 2022-10-28 | 接口版本。当前 API 的版本为 2022-10-28。 |
Body
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| os | String | 是 | pc | 系统。 |
| aid | Long | 是 | 12345 | App ID。 |
| env | String | 否 | crash | 环境信息。 |
FlexFilterCandidateRequest
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| end_time | Integer | 是 | 1668156081 | 结束时间。 |
| start_time | Integer | 是 | 1668156081 | 开始时间。 |
| filter_name | String | 是 | os | 过滤字段名称。 |
| measure_list | Array of FlexMeasure | 是 | - | 相关指标列表。 |
FlexMeasure
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| name | String | 是 | 崩溃影响用户数 | 指标名称。 |
type | String | 是 | monomial
| 指标类型。 |
| customId | String | 否 | xe3ejx98 | 前端用于还原页面。 |
| raw_measure_list | Array of FlexRawMeasure | 是 | - | 具体查询指标。 |
FlexRawMeasure
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| event_name | String | 否 | test_service_gyf | 前端传了此参数, 后端没有用到。但是还原图表的时候是从这个字段读的事件名。 |
| filter_list | Array of FlexFilter | 否 | - | 过滤条件。 |
| measure_name | String | 是 | "{\"metric\":\"pc_flexible.count\",\"event_dimension\":\"pc_flexible.event_name\",\"event_name\":\"test_service_gyf\"}" | 具体的指标计算值。 |
FlexFilter
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| op | String | 是 | in | 过滤方式。 |
| values | Array of String | 是 | ["intel", "Qualcomm"] | 过滤值。 |
| filter_name | String | 是 | cpu | 用于表明filter的哪个维度。 |
返回参数
FlexFilterCandidateResponseData
FlexFilterCandidate
| 参数 | 类型 | 示例值 | 描述 |
|---|
| label | String | windows | 展示值。 |
| value | String | windows | 候选值。 |
请求示例
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": ""
}
错误码
本接口无特有的错误码。更多信息请参见错误码。