GET всех единиц метрик: различия между версиями

Текущая версия от 12:22, 29 декабря 2024

API АппОптима / Эндпойнты среды / Развёртывание / Единицы метрик / GET всех единиц метрик

Перечисляет все доступные метрические единицы вашей среды.

Запрос выдает application/jsonполезную нагрузку.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/units`
GET	Среда ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/units`

Аутентификация

Для выполнения этого запроса вам нужен токен доступа с метриками чтения (metrics.read)

Параметры

Параметр	Тип	Описание	In	Необходимость
unitSelector	string	Выбирает единицы измерения, которые будут включены в ответ. Доступные критерии: Совместимость: `compatibleTo("unit","display-format")`. Возвращает единицы, которые могут быть преобразованы в указанную единицу. Необязательный аргумент формата отображения (`binary`или `decimal`) поддерживается единицами измерения на основе битов и байтов и возвращает только единицы измерения для указанного формата.	query	необязательно
fields	string	Определяет список свойств, которые должны быть включены в ответ. Идентификатор единицы измерения всегда указывается. Доступны следующие дополнительные свойства: `displayName`: Отображаемое имя единицы измерения. `symbol`: Символ единицы измерения. `description`: Краткое описание единицы измерения. По умолчанию включены идентификатор, отображаемое имя и символ. Чтобы добавить свойства, перечислите их с ведущим плюсом `+`. Чтобы исключить свойства по умолчанию, перечислите их с начальным минусом `-`. Чтобы указать несколько свойств, соедините их запятой (например`fields=+description,-symbol`). Если вы укажете только одно свойство, ответ будет содержать идентификатор единицы измерения и указанное свойство. Чтобы возвращать только идентификаторы единиц измерения, укажите `unitId`здесь.	query	необязательно

Ответ

Коды ответов

Код	Тип	Описание
200	List	Успех

Объекты тела ответа

Объект `UnitList`

Список единиц измерения вместе с их свойствами.

Элемент	Тип	Описание
totalCount	integer	Общее количество единиц измерения в результате.
units	Unit[]	Список единиц измерения.

Объект `Unit`

Метаданные единицы измерения.

Элемент	Тип	Описание
unitId	string	Идентификатор устройства.
displayName	string	Отображаемое имя устройства.
symbol	string	Символ единицы измерения.
description	string	Краткое описание единицы измерения.
displayNamePlural	string	Отображаемое имя единицы измерения во множественном числе.

JSON-модель тела ответа

<{
  "totalCount": 2,
  "units": [
    {
      "unitId": "BytePerSecond",
      "displayName": "byte per second",
      "displayNamePlural": "bytes per second",
      "symbol": "B/s",
      "description": "byte per second"
    },
    {
      "unitId": "BytePerMinute",
      "displayName": "byte per minute",
      "displayNamePlural": "bytes per minute",
      "symbol": "B/min",
      "description": "byte per minute"
    }
  ]
}

Пример

В этом примере в запросе перечислены все единицы измерения, доступные для среды.

Токен API передается в заголовке авторизации.

Результат усекается до трех записей.

Curl

<curl --request GET \
  --url https://mySampleEnv.live.ruscomtech.ru/api/v2/units \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/units

Тело ответа

<{
  "totalCount": 3,
  "activeGateTokens": [
    {
        "unitId": "Second",
        "displayName": "second",
        "symbol": "s"
    },
    {
        "unitId": "GigaBit",
        "displayName": "gigabit",
        "symbol": "Gbit"
    },
    {
        "unitId": "KiloBytePerSecond",
        "displayName": "kilobyte per second",
        "symbol": "kB/s"
    }
  ]
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=FAQ-,%D0%95%D0%B4%D0%B8%D0%BD%D0%B8%D1%86%D1%8B%20%D0%BC%D0%B5%D1%82%D1%80%D0%B8%D0%BA,-GET%20%D0%B2%D1%81%D0%B5%D1%85%20%D0%B5%D0%B4%D0%B8%D0%BD%D0%B8%D1%86 Единицы метрик] / GET всех единиц метрик'''''
 Перечисляет все доступные метрические единицы вашей среды.
@@ Строка 127: / Строка 129: @@
       }
     ]
-  }</code>
+  }
 == Пример ==
@@ Строка 139: / Строка 141: @@
   <curl --request GET \
     --url <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/units</nowiki> \
-    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
@@ Строка 164: / Строка 166: @@
       }
     ]
-  }</code>
+  }
 ==== Код ответа ====