Zidium

Отправка одной метрики

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/SendMetric

Метод ищет у компонента метрику с указанным названием.
Если её нет, то метрика будет создана. При необходимости будет также создан тип метрики.
После этого записывается новое значение метрики.
Если новое значение совпадает со старым, то запись в истории не добавляется, а текущее значение метрики продляется.

Запрос
{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "Name": "MetricName",
        "Value": 100.5,
        "ActualIntervalSecs": 600
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey (string) — секретный ключ аккаунта, посмотрите в личном кабинете;
  • ComponentId (guid) — Уникальный Id компонента, для которого отправляется метрика.
  • Name (string) — Название метрики. Используется для создания метрики и типа метрики, если их не удастся найти.
  • Value (double) — Новое значение метрики. Может быть null.
  • ActualIntervalSecs (double) — Интервал актуальности в секундах. Необязательный. Если не указан, то будет равен 1 часу. Итоговый интервал актуальности может быть перекрыт настройками в личном кабинете.

Ответ
{
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "Name": "MetricName",
        "Value": 100.5,
        "BeginDate": "2016-04-30T23:25:43.511Z",
        "ActualDate": "2016-04-30T23:25:43.511Z",
        "Status": "Success"
    },
    "Code": 10
}

Здесь:

  • ComponentId (guid) — Уникальный Id компонента.
  • Name (string) — Название метрики.
  • Value (double) — Текущее значение метрики. Может быть null.
  • BeginDate (datetime) — Дата начала текущего значения.
  • ActualDate (datetime) — Дата актуальности текущего значения.
  • Status (string) — Текущий статус метрики. Может иметь значения: Success, Warning, Alarm, Disabled, Unknown.

Если компонент с указанным Id не существует, то Code будет равен 1100, а Data будет пустым.