/api/serializers

Этот конечный пункт отображает плагины сериализаторов, загруженные работающим TSD. Предоставляемая информация включает имя, реализованные методы, типы содержимого и методы.

Глаголы

GET
POST

Запросы

Параметры недоступны; это конечный пункт только для чтения, который просто возвращает данные системы.

Ответ

Ответ представляет собой массив объектов сериализаторов. Каждый объект имеет следующие поля:

Имя поля	Тип данных	Описание	Пример
serializer	Строка	Имя сериализатора, подходящее для использования в параметре строки запроса `serializer=<serializer_name>`	xml
formatters	Массив<Строка>	Массив методов или конечных пунктов, которые сериализатор реализует для преобразования данных ответа. Обычно они сопоставляются с конечным пунктом, например, `/api/suggest` сопоставляется с `Suggest`. Если сериализатор не реализует определённый метод, будет использоваться метод по умолчанию. Каждое имя также заканчивается поддерживаемой версией API, например, `V1` будет поддерживать вызовы API версии 1.	"Error","Suggest"
parsers	Массив<Строка>	Массив методов или конечных пунктов, которые сериализатор реализует для разбора пользовательского ввода в теле запроса HTTP. Обычно они сопоставляются с конечным пунктом, например, `/api/suggest` будет сопоставляться с `Suggest`. Если сериализатор не реализует парсер, будет использоваться по умолчанию. Каждое имя также заканчивается поддерживаемой версией API, например, `V1` будет поддерживать вызовы API версии 1.	"Suggest","Put"

Этот конечный пункт всегда должен возвращать данные с JSON-сериализатором в качестве значения по умолчанию. Если вы считаете, что TSD должен иметь другие перечисленные форматировщики, проверьте документацию плагина, чтобы убедиться, что у вас есть соответствующий плагин, и он находится в правильной папке.

Пример ответа

[
  {
    "formatters": [
      "SuggestV1",
      "SerializersV1",
      "ErrorV1",
      "ErrorV1",
      "NotFoundV1"
    ],
    "serializer": "json",
    "parsers": [
      "SuggestV1"
    ],
    "class": "net.opentsdb.tsd.HttpJsonSerializer",
    "response_content_type": "application/json; charset=UTF-8",
    "request_content_type": "application/json"
  }
]

© 2010–2016 The OpenTSDB Authors
Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses.
http://opentsdb.net/docs/build/html/api_http/serializers.html