Changes between Version 1 and Version 2 of ApiSnmpget

Timestamp:

Jul 31, 2022, 1:48:01 PM (3 years ago)

Author:

alx

Comment:

--

ApiSnmpget

@@ -32 +32 @@
 == Возвращаемые данные ==
 
-В случае успешного выполнения команда `snmpget` возвращает ключ `result`, значением которого является объект, содержащий результаты чтения переменных. :
+В случае успешного выполнения команда `snmpget` возвращает ключ `result`, значением которого является объект, содержащий результаты чтения переменных. Ключами объекта `result` являются OID переменных, которые были переданы в поле `varlist` запроса. Значением является объект, содержащий результат чтения запрошенной переменной, и имеющий следующий формат:
 
-||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
+||  '''Ключ'''  ||  '''Тип значения'''  ||  '''обязательный'''  ||  '''Описание'''  ||
+||  oid  ||  строка  ||  да  || OID прочитанной переменной - значение совпадает с ключом объекта `result`. ||
+||  status  ||  строка  ||  да  || Индикатор успешности чтения данной переменной - см. ниже ||
+||  value  ||  разный  ||  нет  || Значение, прочитанной из переменной. Присутствует только в случае успешного чтения (`status` == "OK"). ||
 
-Пример ответа:
+Возможные значения поля `status`:
+
+||  '''значение'''  ||  '''описание'''  ||
+||  "OK"  || Чтение переменной выполнено успешно. Прочитанное значение содержится в поле `value`. ||
+||  "Not found"  || Запрошенная переменная отсутствует (неверный OID) ||
+||  "Access denied"  || Запрошенная переменная имеет тип "только для записи" ||
+||  "Timeout"  || Плата, которая содержит переменную, не ответила на запрос чтения (время ожидания ответа истекло) ||
+||  "Error"  || Плата, содержащая запрошенную переменную, вернула ошибку. ||
+
+=== Примеры ответов: ===
+
+Пример ответа на запрос (1):
 
 {{{
+{
+  "cmd":"snmpget",
+  "result": {
+    ".4.2.2.0": {
+      "oid":".4.2.2.0",
+      "status":"OK",
+      "value":"ST-124"
+    },
+    ".4.3.2.0": {
+      "oid":".4.3.2.0",
+      "status":"OK",
+      "value":"E1-08"
+    }
+  }
+}
 }}}
 
+Пример ответа на запрос (2):
+
+{{{
+{
+  "cmd":"snmpget",
+  "result": {
+    ".4.17.5.4.2.0": {
+      "oid":".4.17.5.4.2.0",
+      "status":"Not found"
+    },
+    ".4.17.7.1.1.0": {
+      "oid":".4.17.7.1.1.0",
+      "status":"OK",
+      "value": [1, 25, 6, 45, 0, 0, 215, 43, 23, 23, 0, 1, 0, 0, 255]
+    }
+  }
+}
+}}}
+
+== Примечания ==
+
+При запросе большого числа переменных из одной платы может оказаться, что плата не может поместить значения всех переменных в ответное сообщение, так как размер сообщения ограничен. В этом случае ответ на запрос будет содержать только часть запрошенных переменных. В подобном случае клиенту рекомендуется исключить из списка `varlist` первоначального запроса те переменные, значения которых получены, и повторно запросить только те переменные, ответ на которые не был получен. Пример:
+
+ Запрос: `{"cmd":"snmpget","varlist":[".4.1.5.0", ".4.1.6.0", ".4.1.7.0", ".4.1.8.0", ".4.1.9.0"]}`
+
+ Ответ:
+ {{{
+{
+  "cmd":"snmpget",
+  "result": {
+    ".4.1.5.0": {
+      "oid":".4.1.5.0",
+      "status":"OK",
+      "value": 55
+    },
+    ".4.1.6.0": {
+      "oid":".4.1.6.0",
+      "status":"OK",
+      "value": 55
+    },
+    ".4.1.6.0": {
+      "oid":".4.1.6.0",
+      "status":"OK",
+      "value": 66
+    },
+    ".4.1.7.0": {
+      "oid":".4.1.7.0",
+      "status":"OK",
+      "value": 77
+    }
+  }
+}
+ }}}
+
+ Запрос: `{"cmd":"snmpget","varlist":[".4.1.8.0", ".4.1.9.0"]}`
+
+ Ответ:
+ {{{
+{
+  "cmd":"snmpget",
+  "result": {
+    ".4.1.8.0": {
+      "oid":".4.1.8.0",
+      "status":"OK",
+      "value": 88
+    },
+    ".4.1.9.0": {
+      "oid":".4.1.9.0",
+      "status":"OK",
+      "value": 99
+    }
+  }
+}
+ }}}
 
 == См. также ==