Skip to main content

get_params 获取告警参数

POST /api/v1/alarm/get_params​

描述​

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

访问权限​

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

alarm:get_params

JSON参数​

请求参数如下：

{}

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

请求示例：

{}

响应结果​

请求返回的HTTP状态码为200

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

{
  "success": true|false,
  "data": {
    "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"
  },
  "errorCode": "option string",
  "errorMessage": "option string",
  "showType": 0|1|2|4|9,
  "traceId": "option string"
}
tip
  • reportAddress: 告警上报地址, IP地址或者域名。
  • reportPort: 告警上报端口, 0~65535。 SNMP 默认端口为162。
  • snmpVersion: SNMP版本, 1、2c、3。目前只支持SNMP 2c。
  • community: SNMP 共同体名称。 1、2c版本需要。 3版本是安全名称。
  • v3UserName: SNMP v3 用户名。 3版本需要。
  • v3AuthProtocol v3 认证协议。 3版本需要。
  • v3AuthPassword: v3 认证密码。 3版本需要。
  • v3PrivProtocol: v3 加密协议。 3版本需要。
  • v3PrivPassword: v3 加密密码。 3版本需要。
  • v3SecurityLevel: v3 安全级别。 3版本需要, noAuthNoPriv: 不认证不加密, authNoPriv: 认证不加密, authPriv: 认证加密。

正确结果示例：

{
  "success": true,
  "data": {
    "reportAddress": "192.168.188.24",
    "reportPort": 162,
    "snmpVersion": "2c",
    "community": "public",
    "v3UserName": "",
    "v3AuthProtocol": "MD5",
    "v3AuthPassword": "",
    "v3PrivProtocol": "DES",
    "v3PrivPassword": "",
    "v3SecurityLevel": "noAuthNoPriv"

  }
}

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

{
  "success": false,
  "errorCode": "40004",
  "errorMessage": "no.blank.params",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40004没有空白参数no.blank.params4
tip

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