SNMP陷阱监听器 API

该API允许用户创建SNMP陷阱侦听器。

语法

SNMP v1 Trap:

http://[HOST]:[PORT]/AppManager/xml/AddTrapListener?apikey=[API KEY]&trapName=[TRAP NAME]&trapStatus=[TRAP STATUS]&trapVersion=v1&trapType=[GENERIC TYPE]&specificType=[SPECIFIC TYPE]&enterpriseOID=[ENTERPRISE OID]&severity=[SEVERITY]&filterCondition=[FILTER VARBINDS]&trapCustomVarbinds=[CUSTOMIZE MESSAGE]&associateTrapSeverity=[ASSOCIATE TRAP SEVERITY]&trapHost=[RECEIVE TRAP]&monitorGroups=[MONITOR GROUPS]

SNMP v2 Trap:

http://[HOST]:[PORT]/AppManager/xml/AddTrapListener?apikey=[API KEY]&trapName=[TRAP NAME]&trapStatus=[TRAP STATUS]&trapVersion=v2&trapOID=[TRAP OID]&severity=[SEVERITY]&filterCondition=[FILTER VARBINDS]&trapCustomVarbinds=[CUSTOMIZE MESSAGE]&associateTrapSeverity=[ASSOCIATE TRAP SEVERITY]&trapHost=[RECEIVE TRAP]&monitorGroups=[MONITOR GROUPS]

SNMP v3 Trap:

http://[HOST]:[PORT]/AppManager/xml/AddTrapListener?apikey=[API KEY]&trapName=[TRAP NAME]&trapStatus=[TRAP STATUS]&trapVersion=v3&trapOID=[TRAP OID]&v3UserName=[V3 USERNAME]&severity=[SEVERITY]&filterCondition=[FILTER VARBINDS]&trapCustomVarbinds=[CUSTOMIZE MESSAGE]&associateTrapSeverity=[ASSOCIATE TRAP SEVERITY]&trapHost=[RECEIVE TRAP]&monitorGroups=[MONITOR GROUPS]

请求参数

API请求中涉及的参数如下所述。另外，请参阅常见的请求参数列表。 要了解有关HTTP错误代码的更多信息， 请参见此处。

字段 描述 备注
API Key 通过管理标签中的生成API密钥选项生成的密钥 。  
trapName SNMP陷阱侦听器的名称。  
trapStatus 陷阱侦听器的状态。（启用或禁用）  
trapVersion SNMP陷阱侦听器的版本。（v1，v2或v3）  
trapType 陷阱的通用类型。可能的值为：
  • 0 - coldStart
  • 1 - warmStart
  • 2 - linkDown
  • 3 - linkUp
  • 4 - authenticationFailure
  • 5 - egpNeighbourLoss
  • 6 - enterpriseSpecific
 可选（版本v1必选）
specificType 陷阱的特定类型（对于企业特定陷阱（例如，对于trapType = 6）。
  • 可选（如果trapType为6则必须提供）
  • '*'表示与任何特定类型匹配。
enterpriseOID v1陷阱的企业对象ID（OID）。 可选（版本v1必选）
trapOID v2 / v3陷阱的对象ID（OID）。 可选（对于v2和v3版本是必需的）
v3UserName v3陷阱的用户名。 可选（版本v3必选）
filterCondition 根据变量绑定过滤陷阱的条件。（AND/ OR） 可选
filterText 可变绑定条件以过滤陷阱。条件应以JSON数组格式指定为：

{"varId":"[VAR ID]","varCondition":"[VAR CONDITION]","varValue":"[VAR VALUE]"}


参数 描述
VAR ID 变量绑定索引号。如果选择WHOLE条件，则VAR ID应为0。
VAR CONDITION 过滤条件。可能的值为：
  • QL-等于
  • NQ-不等于
  • CT-包含
  • DC-不包含
  • SW-开头
  • EW-结尾为
VAR VALUE 要匹配的字符串值。
可选
trapCustomVarbinds 用于自定义陷阱消息的消息（Varbinds）。可能的值为：
  • $ *
  • $ 1，$ 2，$ 3，...，$ N
  • 任何带有选定变量的用户定义消息。{例如。$ 4的配置在$ 2中进行了更改。更改者：$ 5}
 可选
associateTrapSeverity 将陷阱严重级别与服务器健康状况相关联。（true或false）默认情况下，value为false。 可选
trapHost 陷阱的主机，如果您只想从该主机接收陷阱。 可选
monitorGroups 要将陷阱侦听器映射到的业务组的ID。 可选
severity 收到陷阱时陷阱监听器的严重级别。可能的值是critical，warning，clear或varbindbased。 如果必须基于变量绑定配置严重级别，请提供varbindbased作为值。
criticalCondition, warningCondition, clearCondition 评估临界/警告/正常严重级别的阈值的条件。可能的值是AND，OR或WHOLE。
  • 可选（如果严重级别基于varbind，则criticalCondition字段为必填）
  • 选择全，如果你想以配合整体的陷阱消息，而不是个别变量绑定的阈值。
criticalThreshold, warningThreshold, clearThreshold 可变绑定阈值条件可确定严重 /警告 /正常严重级别。阈值条件应以JSON数组格式指定为：

{"varId":"[VAR ID]","varCondition":"[VAR CONDITION]","varValue":"[VAR VALUE]"}


参数 描述
VAR ID 变量绑定索引号。如果选择WHOLE条件，则VAR ID应为0。
VAR CONDITION 阈值条件。可能的值为：
  • QL-等于
  • NQ-不等于
  • CT-包含
  • DC-不包含
  • SW-开头
  • EW-结尾为
VAR VALUE 要匹配的字符串值。
可选（如果严重级别是基于varbind的，则criticalThreshold字段为必填）
criticalActions, warningActions, clearActions 如果严重级别为严重 /警告 /正常，则要配置的操作的操作ID。 可选

注意:最多只能接受20个条件。如果条件数大于20，则将其视为无效。

示例请求

SNMP v1 Trap:

http://localhost:9091/AppManager/xml/AddTrapListener?apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v1&severity=critical&trapType=6&specificType=2&enterpriseOID=.1.2.3.4&trapName=trap1OID&associateTrapSeverity=true

SNMP v2 Trap:

http://localhost:9091/AppManager/xml/AddTrapListener?apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v2&severity=critical&trapOID=.0.1.2.3.4&trapName=trap2

SNMP v3 Trap:

http://localhost:9091/AppManager/xml/AddTrapListener?apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v3&severity=clear&trapOID=.0.1.2.3.4&trapName=trap3&v3UserName=mithun

使用varbind过滤器和基于varbind的严重级别：

http://localhost:9091/AppManager/xml/AddTrapListener?apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&filterCondition=OR&filterText={"varId":"1","varCondition":"CT","varValue":"critical"},{"varId":"3","varCondition":"SW","varValue":"hi"}&trapVersion=v1&severity=varbindbased&criticalCondition=AND&criticalThreshold={"varId":"1","varCondition":"CT","varValue":"critical"}&trapType=6&specificType=2&enterpriseOID=.1.2.3.4&trapName=trap1OID&associateTrapSeverity=true

通过动作和业务组：

http://localhost:9091/AppManager/xml/AddTrapListener?apikey=1e391cc0520ece06cbb85766fafebf78&trapStatus=enable&trapVersion=v1&severity=varbindbased&criticalCondition=AND&criticalThreshold={"varId":"1","varCondition":"CT","varValue":"critical"}&warningCondition=AND&warningThreshold={"varId":"1","varCondition":"CT","varValue":"critical"}&clearCondition=AND&clearThreshold={"varId":"1","varCondition":"CT","varValue":"critical"}&trapType=6&specificType=2&enterpriseOID=.1.2.3.4&trapName=trap1OID&associateTrapSeverity=true&warningActions=10000003,10000004,10000005&monitorGroups=10000013,100000134