GET одной единицы метрик
Материал из Документация Ключ-АСТРОМ
Возвращает свойства единицы метрики.
Запрос выдает application/json
полезную нагрузку.
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/units/{unitId}
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/units/{unitId}
|
Аутентификация
Для выполнения этого запроса вам нужен токен доступа с метриками чтения (metrics.read
)
Параметры
Параметр | Тип | Описание | In | Требуется |
---|---|---|---|---|
nitId | string | Идентификатор требуемого устройства. | path | требуется |
Ответная реакция
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Успех | |
404 | Не найдено. Запрошенный ресурс не найден или запрос неверен. |
Объекты тела ответа
The Unit
Метаданные единицы измерения.
Элемент | Тип | Описание |
---|---|---|
unitId | string | Идентификатор устройства. |
displayName | string | Отображаемое имя единицы измерения. |
symbol | string | Символ единицы измерения. |
description | string | Краткое описание единицы измерения. |
displayNamePlural | string | Отображаемое имя единицы измерения во множественном числе. |
JSON-модель тела ответа
{
"unitId": "Second",
"displayName": "second",
"displayNamePlural": "seconds",
"symbol": "s",
"description": "The second is the base unit of time and defined as 1/86400 of a day."
}
Пример
В этом примере запрос извлекает метаданные единицы измерения отношения.
Токен API передается в заголовке авторизации.
Curl
curl --request GET \
--url https://mySampleEnv.live.ruscomtech.ru//api/v2/units/MebiByte \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru//api/v2/units/MebiByte
Тело ответа
{
"unitId": "MebiByte",
"displayName": "mebibyte",
"symbol": "MiB",
"description": "1048576.0 byte"
}
Код ответа
200