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

Версия от 08:29, 26 декабря 2024

Возвращает свойства единицы метрики.

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

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/units/{unitId}`
GET	Среда АктивногоШлюза	`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

@@ Строка 4: / Строка 4: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/units/{unitId}</nowiki></code>
 |-
@@ Строка 77: / Строка 77: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "unitId": "Second",
     "displayName": "second",
@@ Строка 91: / Строка 91: @@
 ==== Curl ====
-  <code>curl --request GET \
+  <curl --request GET \
     --url <nowiki>https://mySampleEnv.live.ruscomtech.ru//api/v2/units/MebiByte</nowiki> \
     --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
@@ Строка 99: / Строка 99: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "unitId": "MebiByte",
     "displayName": "mebibyte",