Документация / API / Json / Метрики / GetMetric

---

Получение метрики по названию типа

АдресВашегоСервисаApi/GetMetric

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "Name": "MetricName"
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• ComponentId (guid) — Уникальный Id компонента, для которого ищется метрика.
• Name (string) — Название типа метрики для поиска.

{
    "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 будет пустым.

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