跳到主要内容

save_params 保存告警参数

POST /api/v1/alarm/save_params​

描述​

保存告警参数接口，用于保存告警参数信息。 告警参数包括告警级别、告警上报地址、告警上报端口、告警上报协议等。

访问权限​

需要登录，具备以下权限：

alarm:save_params

JSON参数​

请求参数如下：

{
  "reportAddress": string,
  "ipVersion": 4|6,
  "reportPort": 0~65535,
  "snmpVersion": "1"|"2c"|"3",
  "community": string,
  "v3UserName": string,
  "v3AuthProtocol": "MD5"|"SHA",
  "v3AuthPassword": string,
  "v3PrivProtocol": "DES"|"AES",
  "v3PrivPassword": string,
  "v3SecurityLevel": "noAuthNoPriv"|"authNoPriv"|"authPriv"
}

无参数，必须传递空对象。

请求示例：

{
  "reportAddress": "192.168.188.24",
  "reportPort": 162,
  "snmpVersion": "2c",
  "community": "public",
  "v3UserName": "",
  "v3AuthProtocol": "MD5",
  "v3AuthPassword": "",
  "v3PrivProtocol": "DES",
  "v3PrivPassword": "",
  "v3SecurityLevel": "noAuthNoPriv"
}
提示

SNMP 默认端口为162，HTTP 默认端口为80，HTTPS 默认端口为443。

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

正确结果示例：

{
  "success": true
}

错误结果示例, 返回false时候需要带上错误码和错误信息：

{
  "success": false,
  "errorCode": "40007",
  "errorMessage": "error.request.format",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40007请求格式错误error.request.format4
40007请求参数类型有误error.request.params.type4
40007ip版本必须为4或6ip.version.must.be.4.or.64
40007上报端口必须在0~65535之间report.port.must.between.0.and.655354
40007SNMP版本必须为1、2c、3snmp.version.must.be.1.2c.or.34
40007v3认证协议必须为MD5或SHAv3.auth.protocol.must.be.MD5.or.SHA4
40007v3加密协议必须为DES或AESv3.priv.protocol.must.be.DES.or.AES4
40007v3密码必须为8~64位v3.auth.password.length.must.between.8.and.644
40007v3加密密码必须为8~64位v3.priv.password.length.must.between.8.and.644
提示

4 表示弹框提示错误信息。

9 表示页面弹框提示错误信息。