(Новая страница: «Этот вызов API экспортирует данные об использовании лицензий в архивный файл. Запрос про...») |
Нет описания правки |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v2]] / [[API Кластера v2|Лицензирование]] / Экспорт данных лицензии''''' | |||
Этот вызов API экспортирует данные об использовании лицензий в архивный файл. | Этот вызов API экспортирует данные об использовании лицензий в архивный файл. | ||
Запрос производит полезную нагрузку <code>application/octet-stream</code>. | Запрос производит полезную нагрузку <code>application/octet-stream</code>. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/cluster/v2/license/consumption</code> | <code>/api/cluster/v2/license/consumption</code> | ||
| Строка 25: | Строка 27: | ||
|} | |} | ||
==Пример== | ==Пример== | ||
В этом примере вы запрашиваете данные лицензии из развертывания | В этом примере вы запрашиваете данные лицензии из развертывания АппОптима в диапазоне от <code>19 марта 2020 г. 6:00 (1584594000000)</code> до <code>9 июня 2020г. 17:00 (1591714800000)</code>. | ||
====Curl==== | ====Curl==== | ||
<code>curl -X GET "<nowiki>https:// | <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/cluster/v2/license/consumption?startTs=1584594000000&endTs=1591714800000</nowiki>" -H "accept: application/octet-stream"</code> | ||
====URL-адрес запроса==== | ====URL-адрес запроса==== | ||
<code><nowiki>https:// | <code><nowiki>https://myАппОптима.cluster.com/api/cluster/v2/license/consumption?startTs=1584594000000&endTs=1591714800000</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
ZIP-файл, содержащий файлы данных лицензии в формате JSON. Дополнительные сведения о формате JSON см. в разделе [[Экспорт данных о лицензировании]]. | ZIP-файл, содержащий файлы данных лицензии в формате JSON. Дополнительные сведения о формате JSON см. в разделе [[Экспорт данных о лицензировании]]. | ||
Текущая версия от 07:50, 7 января 2025
Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v2 / Лицензирование / Экспорт данных лицензии
Этот вызов API экспортирует данные об использовании лицензий в архивный файл.
Запрос производит полезную нагрузку application/octet-stream.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение одной из областей API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/cluster/v2/license/consumption
Ответ
Коды ответа
| Код | Описание |
|---|---|
| 200 | OK - экспорт данных о потреблении лицензий начинается |
| 400 | Плохой запрос. Указанный диапазон времени неверен. |
| 429 | Данные об использовании лицензий уже экспортируются. Дождитесь завершения первого запроса, прежде чем запрашивать другой экспорт. |
| 500 | Операция не удалась |
Пример
В этом примере вы запрашиваете данные лицензии из развертывания АппОптима в диапазоне от 19 марта 2020 г. 6:00 (1584594000000) до 9 июня 2020г. 17:00 (1591714800000).
Curl
curl -X GET "https://myАппОптима.cluster.com/api/cluster/v2/license/consumption?startTs=1584594000000&endTs=1591714800000" -H "accept: application/octet-stream"
URL-адрес запроса
https://myАппОптима.cluster.com/api/cluster/v2/license/consumption?startTs=1584594000000&endTs=1591714800000
Тело ответа
ZIP-файл, содержащий файлы данных лицензии в формате JSON. Дополнительные сведения о формате JSON см. в разделе Экспорт данных о лицензировании.
Код ответа
200