/api/uid/uidmeta

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

Примечание

Удаление записи метаданных не удалит привязку UID, а также не удалит никакие точки данных или связанную информацию о временных рядах. Удаление только удаляет указанный объект метаданных, а не фактическое значение. Если вы запросите тот же UID, вы увидите метаданные по умолчанию с пустыми полями.

Глаголы

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

Запросы

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

Имя	Тип данных	Обязательно	Описание	Значение по умолчанию	QS	Чтение/запись	Пример
uid	Строка	Обязательно	Шестнадцатеричное представление UID		uid	Только для чтения	00002A
type	Строка	Обязательно	Тип UID, должен быть `metric`, `tagk` или `tagv`		type	Только для чтения	metric
description	Строка	Необязательно	Краткое описание того, что представляет UID		description	Чтение/запись	Время работы процессора системы
displayName	Строка	Необязательно	Короткое имя, которое может отображаться в графических пользовательских интерфейсах вместо имени по умолчанию		display_name	Чтение/запись	Время работы процессора системы
notes	Строка	Необязательно	Подробные заметки о том, что представляет UID		notes	Чтение/запись	Подробности
custom	Словарь	Необязательно	Словарь пар «ключ-значение» для хранения пользовательских полей и значений	null		Чтение/запись	См. ниже

Примечание

Пользовательские поля не могут быть переданы через строку запроса. Вы должны использовать глаголы POST или PUT.

Предупреждение

Если ваш запрос использует PUT, все поля, которые вы не предоставляете в запросе, будут перезаписаны значениями по умолчанию. Например, поле description будет установлено в пустую строку, а поле custom будет сброшено до null.

Пример запроса GET

http://localhost:4242/api/uid/uidmeta?uid=00002A&type=metric

Пример запроса POST или PUT

Строка запроса:

http://localhost:4242/api/uid/uidmeta?uid=00002A&type=metric&method=post&display_name=System%20CPU%20Time

Содержимое JSON:

{
  "uid":"00002A",
  "type":"metric",
  "displayName":"System CPU Time",
  "custom": {
    "owner": "Jane Doe",
    "department": "Operations",
    "assetTag": "12345"
  }
}

Пример запроса DELETE

Строка запроса:

http://localhost:4242/api/uid/uidmeta?uid=00002A&type=metric&method=delete

Содержимое JSON:

{
  "uid":"00002A",
  "type":"metric"
}

Ответ

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

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

Имя	Тип данных	Описание	Пример
name	Строка	Имя UID, указанное при хранении точки данных или при назначении UID	sys.cpu.0
created	Целое число	Маркер времени эпохи Unix в секундах, когда UID был впервые создан. Если метаданные не были сохранены при назначении UID, это значение может быть 0.	1350425579

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

{
  "uid": "00002A",
  "type": "TAGV",
  "name": "web01.mysite.com",
  "description": "Website hosting server",
  "notes": "This server needs a new boot disk",
  "created": 1350425579,
  "custom": {
    "owner": "Jane Doe",
    "department": "Operations",
    "assetTag": "12345"
  },
  "displayName": "Webserver 01"
}

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