GET единиц преобразования: различия между версиями

Текущая версия от 16:06, 25 декабря 2024

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

Если целевая единица измерения не задана, запрос автоматически находит соответствующую целевую единицу измерения с учетом предпочтительного числового формата (если указан).

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

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

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

Для выполнения этого запроса вам нужен токен доступа с областью чтения metrics (metrics.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация.

Параметры

Параметр	Тип	Описание	In	Необходимость
unitId	string	Идентификатор исходной единицы измерения.	path	требуется
value	number	Значение, подлежащее преобразованию.	query	требуется
targetUnit	string	Идентификатор целевой единицы измерения.	query	необязательно
numberFormat	string	Предпочтительный формат чисел. Учитывается только в том случае, если не указана целевая единица измерения.	query	необязательно

Ответ

Коды ответов

Код	Тип	Описание
200	Result	Успех
404		Не найдено. Запрошенный ресурс не найден или запрос неверен.

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

Объект `UnitConversionResult`

Результат преобразования единиц измерения.

Элемент	Тип	Описание
unitId	string	Идентификатор единицы измерения этого результата преобразования.
resultValue	number	Результат преобразования единиц измерения.

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

<{
  "unitId": "string",
  "resultValue": 1
}

@@ Строка 6: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/units/{unitId}/convert</nowiki></code>
 |-
@@ Строка 85: / Строка 85: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "unitId": "string",
     "resultValue": 1
   }</code>