/api/suggest
Этот конечный пункт предоставляет средство реализации вызова «автозаполнения», к которому можно многократно обращаться по мере ввода пользователем запроса в графическом интерфейсе. Он не предоставляет полнотекстовый поиск или подстановочные знаки, а просто сопоставляет всю строку, переданную в запросе, с первыми символами сохраненных данных. Например, передача запроса type=metrics&q=sys вернёт 25 наиболее важных метрик в системе, которые начинаются с sys. Сопоставление чувствительно к регистру, поэтому sys не будет соответствовать System.CPU. Результаты сортируются в алфавитном порядке.
Глаголы
- GET
- POST
Запросы
| Имя | Тип данных | Обязательно | Описание | Значение по умолчанию | QS | RW | Пример |
|---|---|---|---|---|---|---|---|
| type | Строка | Обязательно | Тип данных для автозаполнения. Должен быть одним из следующих: metrics, tagk или tagv | type | metrics | ||
| q | Строка | Необязательно | Строка для сопоставления с заданным типом | q | web | ||
| max | Целое число | Необязательно | Максимальное количество предложенных результатов для возврата. Должно быть больше 0 | 25 | max | 10 |
Пример запроса
Строка запроса
http://localhost:4242/api/suggest?type=metrics&q=sys&max=10
JSON-контент
{
"type":"metrics",
"q":"sys",
"max":10
}
Ответ
Ответ представляет собой массив строк заданного типа, соответствующих запросу. Если ничего не найдено для соответствия запросу, будет возвращён пустой массив.
Пример ответа
[ "sys.cpu.0.nice", "sys.cpu.0.system", "sys.cpu.0.user", "sys.cpu.1.nice", "sys.cpu.1.system", "sys.cpu.1.user" ]
© 2010–2016 The OpenTSDB Authors
Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses.
http://opentsdb.net/docs/build/html/api_http/suggest.html