GET всех единиц метрик

Материал из Dynatrace

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

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/units
Среда 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