/api/uid/tsmeta

Этот конечный пункт позволяет искать, редактировать или удалять метаданные временных рядов, то есть метаданные, связанные со специфическим временным рядом, связанным с метрикой и одной или несколькими парами имя тега/значение. Некоторые поля устанавливаются TSD, а другие могут быть установлены пользователем. При использовании метода POST, будут сохранены только поля, предоставленные в запросе. Существующие поля, которые не включены, останутся без изменений. Использование метода PUT перезапишет все изменяемые пользователем поля заданными значениями или значениями по умолчанию, если заданное поле не предоставлено.

Обратите внимание, что удаление записи метаданных не удалит точки данных, сохранённые для временного ряда. Также это не удалит назначения UID или связанные объекты метаданных UID.

Глаголы

• GET - Поиск одного или нескольких метаданных TS
• POST - Обновляет только предоставленные поля
• PUT - Перезаписывает все пользовательские конфигурируемые поля метаданных
• DELETE - Удаляет метаданные TS

GET-запросы

GET-запрос может искать объекты метаданных TS для одного или нескольких временных рядов, если они существуют в системе хранения. Поддерживаются два типа запросов:

• tsuid - Может быть предоставлен один шестнадцатеричный TSUID, и если он найден, будет возвращён объект метаданных. Результаты будут включать один объект.
• метрика - (Версия 2.1) Похоже на запрос точки данных, вы можете указать метрику и одну или несколько пар тегов. Будут возвращены все метаданные TS, соответствующие запросу. Результаты будут массивом из одного или нескольких объектов. В одном вызове может быть указан только один запрос метрики, и не поддерживаются подстановочные знаки или операторы группировки.

http://localhost:4242/api/uid/tsmeta?tsuid=00002A000001000001

http://localhost:4242/api/uid/tsmeta?m=sys.cpu.nice&dc=lga

POST/PUT-запросы

По умолчанию, вы можете записывать данные в объект метаданных TS только если он уже существует. Метаданные TS создаются через команду meta sync CLI или в реальном времени по мере записи точек данных. Если вы попытаетесь записать данные в конечную точку tsmeta для TSUID, который не существует, будет возвращена ошибка, и данные не будут сохранены.

Поля, которые могут быть предоставлены в запросе, включают:

В OpenTSDB 2.1 вы можете указать запрос в стиле метрики, и если UID существуют для заданной метрики и тегов, будет сохранён новый объект метаданных TS. Данные могут быть предоставлены через POST для вышеперечисленных полей, как и в обычном запросе, однако поле tsuid должно быть пустым. Кроме того, должны быть предоставлены два параметра строки запроса:

• m - Метрика и теги, аналогичные запросу GET или запросу точки данных
• create - Флаг со значением true

Например:

http://localhost:4242/api/uid/tsmeta?display_name=Testing&m=sys.cpu.nice{host=web01,dc=lga}&create=true&method_override=post

Если объект метаданных TS уже существует в хранилище для заданной метрики и тегов, поля будут обновлены или перезаписаны.

http://localhost:4242/api/uid/tsmeta?tsuid=00002A000001000001&method_override=post&display_name=System%20CPU%20Time

{
  "tsuid":"00002A000001000001",
  "displayName":"System CPU Time for Webserver 01",
  "custom": {
    "owner": "Jane Doe",
    "department": "Operations",
    "assetTag": "12345"
  }
}

http://localhost:4242/api/uid/tsmeta?tsuid=00002A000001000001&method_override=delete

{
  "tsuid":"00002A000001000001"
}

Ответ

Успешный ответ на запрос GET, POST или PUT вернёт полный объект метаданных TS с внесёнными изменениями. Успешные вызовы DELETE вернут код состояния 204 и не будут содержать тела ответа. При изменении данных, если изменений не было, то есть вызов не предоставил данных для хранения, ответ будет 304 без тела ответа. Если запрошенный TSUID не существует в системе, будет возвращена ошибка 404 с сообщением об ошибке. Если были предоставлены неверные данные, будет возвращена ошибка.

Все поля Запроса будут присутствовать в ответе, а также и другие:

{
  "tsuid": "00002A000001000001",
  "metric": {
    "uid": "00002A",
    "type": "METRIC",
    "name": "sys.cpu.0",
    "description": "System CPU Time",
    "notes": "",
    "created": 1350425579,
    "custom": null,
    "displayName": ""
  },
  "tags": [
    {
      "uid": "000001",
      "type": "TAGK",
      "name": "host",
      "description": "Server Hostname",
      "notes": "",
      "created": 1350425579,
      "custom": null,
      "displayName": "Hostname"
    },
    {
      "uid": "000001",
      "type": "TAGV",
      "name": "web01.mysite.com",
      "description": "Website hosting server",
      "notes": "",
      "created": 1350425579,
      "custom": null,
      "displayName": "Web Server 01"
    }
  ],
  "description": "Measures CPU activity",
  "notes": "",
  "created": 1350425579,
  "units": "",
  "retention": 0,
  "max": "NaN",
  "min": "NaN",
  "custom": {
    "owner": "Jane Doe",
    "department": "Operations",
    "assetTag": "12345"
  },
  "displayName": "",
  "dataType": "absolute",
  "lastReceived": 1350425590,
  "totalDatapoints", 12532
}