获取错误新增报警规则详情。
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetWebProNewErrorAlertRuleDetail | 接口名称。当前 API 的名称为 GetWebProNewErrorAlertRuleDetail。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| common | Object of CommonParams | 否 | - | 通用参数。 |
| id | Long | 否 | 1 | 报警ID。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | test_user | 用户名。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| data | Object of AlertDetail | - | 返回内容。 |
| errmsg | String | "" | 错误信息。成功为""。 |
| errno | Integer | 0 | 错误码。成功为0。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| created_by | String | leeac | 报警任务创建人。 |
| updated_by | String | leeac | 报警任务最近修改人。 |
| alert_param | Object of AlertParam | - | 报警参数集合。 |
| created_time | Long | 1665409567 | 报警任务创建时间。 |
| updated_time | Long | 1665409567 | 报警任务最近修改时间。 |
| last_month_alert_count | Integer | 0 | 报警任务最近一个月报警次数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| id | Long | 1 | 报警任务ID。 |
| name | String | test | 报警任务名称。 |
| chats | Array of String | [1234] | 报警通知群。 |
methods | Array of String |
| 配置报警通知方式。
|
is_close | Boolean |
| 是否开启报警。
|
| receivers | Array of String | [] | 接收人。当报警通知方式为lark时必填。 |
alert_level | String |
| 报警级别。
|
| mail_groups | Array of String | [123] | 邮件通知组。 |
| lark_at_conf | Object of AtConf | Jack | 飞书需要at的人。 |
| callback_urls | Array of String | [] | 报警回调webhook。 |
| lark_webhooks | Array of String | [] | 飞书webhook。 |
alert_language | String |
| 报警语言。
|
alert_strategy | Object of AlertStrategy |
| 报警策略。多策略之间的关系只能是或。
|
| wechat_at_conf | Object of AtConf | Rose | 企业微信需要at的人。 |
| dingding_at_conf | Object of AtConf | Carl | 钉钉需要at的人。 |
| we_chat_webhooks | Array of String | [] | 企业微信webhook。 |
| dingding_webhooks | Array of String | [] | 钉钉webhook。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| id_type | String | userid | 类型。 |
| id_values | Array of String | [] | 类型对应的值。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
evType | String |
| 枚举类型。
|
| releases | Array of String | 2.0.0 | 如果关注的是版本的新增错误，则需要传关注的版本列表。 |
| disappear_time | Integer | 30 | 多少天未出现认为是新错误。 |
| user_threshold | Integer | 100 | 用户数阈值。 |
| filter_condition | Object of FilterConditions | - | 筛选条件。 |
| sample_threshold | Integer | 100 | 样本数量阈值。 |
isReleaseNewError | Boolean |
| 是否关注的是版本新增错误。
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| type | String | and | 筛选条件key。 |
| sub_conditions | Array of SubCondition | [] | 筛选条件值。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
op | String |
| 条件符号。
|
| value | String | - | 筛选值的值，表示等值。 |
| values | Array of String | - | 筛选值的值，表示范围。 |
| groupKey | String | - | 报警分组维度。 |
| dimension | String | - | 报警归因维度。 |
POST https://open.volcengineapi.com/?Action=GetWebProNewErrorAlertRuleDetail&Version=2022-10-12 { "id": 1, "common": { "aid": 1, "os": "webpro" } }
{ "err_detail": "", "data": { "alert_param": { "id": 1, "name": "newRule", "is_close": false, "methods": [ "lark_webhook" ], "feedback_duty_name": "", "note": "", "alert_language": "zh", "alert_level": "warning", "lark_webhooks": [ "your webhook" ], "lark_at_conf": { "id_type": "userid", "id_values": [] }, "alert_strategy": { "evType": "js_error", "isReleaseNewError": true, "disappear_time": 30, "filter_condition": { "type": "and", "sub_conditions": [] }, "user_threshold": 200, "sample_threshold": 100, "strategy_update_time": 1720067406 } }, "created_by": "your@email.com", "updated_by": "your@email.com", "created_time": 1720067407, "updated_time": 1720072327, "last_month_alert_count": 0 }, "error_msg": "", "error_no": 0 }
本接口无特有的错误码。更多信息请参见错误码。