list
Для получения протоколов ретрансляции, доступных текущему пользователю, используйте метод retranslator/list. Ответ содержит как стандартные протоколы, так и пользовательские, разрешенные для учетной записи.
Конечная точка
svc=retranslator/list¶ms={}
Параметры
У метода нет параметров. Передайте в запросе пустой объект.
Ответ
В случае успешного выполнения запроса возвращается ответ следующего формата:
{
"custom_retranslators": [ /* Пользовательские протоколы, доступные пользователю. */
{
"name": "apad_gps", /* Значение для поля "protocol" конфигурации. */
"params": {
"fields": [ /* Поля конфигурации. */
{
"key": "server", /* Название поля. */
"type": "name" /* Тип поля. */
},
{
"key": "api_key",
"type": "name"
},
{
"key": "password",
"type": "name"
}
],
"name": "APAD GPS", /* Название протокола, которое отображается в интерфейсе. */
"public": 1 /* Доступность всем пользователям: 1 — да, 0 — нет. */
}
},
...
],
"retranslators": [ /* Стандартные протоколы. */
{
"name": "wialon",
"params": {
"fields": [
{
"key": "server",
"type": "name"
},
{
"key": "port",
"type": "uint16",
"default": 20163 /* Значение поля по умолчанию. */
},
{
"key": "attach_sensors",
"type": "bool"
}
]
}
},
...
]
}
Пользовательский протокол включается в ответ, если он отмечен как публичный, если в учетной записи включена соответствующая услуга или если у пользователя есть права администратора. Если ни одного пользовательского протокола нет, массив custom_retranslators в ответе отсутствует. Массив retranslators возвращается всегда, а протоколы в нем описаны в методе update_config.
Описание протокола зависит от самого протокола:
- Тип поля (
type) показывает, как его заполнять. Помимоname, используются типыbool,int,int16,uint16и другие. - У поля может быть ключ
defaultсо значением, которое интерфейс предлагает для него. Он используется как в стандартных, так и в пользовательских протоколах. - Кроме
fields,nameиpublic, объектparamsпользовательского протокола может содержать другие ключи с настройками этого протокола, напримерsending_optionsилиlocation_conversion.
В противном случае возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 5 | Не удалось сгенерировать ответ. |
| 6 | В текущей сессии нет пользователя. |