Просмотр кода страницы API развертывания — Список доступных версий ЕдиногоАгента


= API развертывания — Список доступных версий ЕдиногоАгента =
Отображает список всех доступных версий установщика ЕдиногоАгента.

Запрос формирует полезную нагрузку <code>application/json</code>.

'''GET'''<pre>
SaaS: https://{your-environment-id}.live.astromkey.com/api/v1/deployment/installer/agent/versions/{osType}/{installerType}
</pre>'''GET'''<pre>
Среда Активного Шлюза: https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/agent/versions/{osType}/{installerType}
</pre>

== Аутентификация ==
Для выполнения этого запроса вам потребуется токен доступа с областью действия <code>InstallerDownload</code>.

Чтобы узнать, как получить и использовать его, см. раздел «Токены и аутентификация».

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|<code>osType</code>
|string
|Операционная система установщика. Этот элемент может содержать следующие значения: <code>AIX</code>, <code>LINUX</code>, <code>SOLARIS</code>, <code>WINDOWS</code>, <code>ZOS</code>.
|path
|Необходимый
|-
|<code>installerType</code>
|string
|Тип установщика:

* <code>default</code>: Самораспаковывающийся установщик для ручной установки. Загружает <code>.exe</code> файл для Windows или <code>.sh</code> файл для Unix.
* <code>default-unattended</code>: Самораспаковывающийся установщик для автоматической установки. Только для Windows. Загружает <code>.zip</code> архив, содержащий <code>.msi</code> установщик и пакетный файл. Эта опция устарела в версии ЕдиныйАгент 1.173.
* <code>mainframe</code>: Загружает все модули кода для z/OS, объединенные в один <code>*.pax</code> архив.
* <code>paas</code>: Установщик модулей кода. Загружает <code>*.zip</code> архив, содержащий <code>manifest.json</code> файл с метаинформацией или <code>.jar</code> файл для z/OS.
* <code>paas-sh</code>: Установщик модулей кода. Загружает самораспаковывающийся скрипт оболочки со встроенным <code>tar.gz</code> архивом.Этот элемент может содержать следующие значения: <code>default</code>, <code>default-unattended</code>, <code>mainframe</code>, <code>paas</code>, <code>paas-sh</code>.
|path
|Необходимый
|-
|<code>flavor</code>
|string
|Тип вашей дистрибуции Linux:

* <code>musl</code> для дистрибутивов Linux, использующих стандартную библиотеку C musl, например, Alpine Linux.
* <code>multidistro</code> для дистрибутивов Linux, использующих стандартные библиотеки musl C и glibc.
* <code>default</code> для дистрибутивов Linux, использующих стандартную библиотеку glibc.

Применимо только к типам установщиков <code>paas</code> и <code>paas-sh</code>.
Этот элемент может содержать следующие значения: <code>default</code>, <code>multidistro</code>, <code>musl</code>.
|query
|Необязательный
|-
|<code>arch</code>
|string
|Архитектура вашей операционной системы:

* <code>all</code> Используйте это значение для AIX и z/OS. <code>x86</code> Для других типов ОС по умолчанию используется значение по умолчанию.
* <code>x86</code> Архитектура x86.
* <code>ppc</code> Архитектура PowerPC, поддерживается только для AIX.
* <code>ppcle</code> Архитектура PowerPC Little Endian, поддерживается только в Linux.
* <code>sparc</code> Архитектура Sparc, поддерживается только для Solaris.
* <code>arm</code> Архитектура ARM, поддерживается только в Linux.
* <code>s390</code> Архитектура S/390, поддерживается только для Linux.

Применимо только к типам установщиков <code>paas</code> и <code>paas-sh</code>.
Этот элемент может содержать следующие значения: <code>all</code>, <code>arm</code>, <code>ppc</code>, <code>ppcle</code>, <code>s390</code>, <code>sparc</code>, <code>x86</code>.
|query
|Необязательный
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|200
|Версии установщика агента
|Успех. Полезная нагрузка содержит доступные версии.
|-
|4XX
|Оболочка ошибки
|Ошибка на стороне клиента.
|-
|5XX
|Оболочка ошибки
|Ошибка на стороне сервера.
|}

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

=== Объект AgentInstallerVersions ===
Список доступных версий установщика ЕдиногоАгента.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|<code>availableVersions</code>
|string []
|Список доступных версий установщика ЕдиногоАгента.
|}

=== Объект ErrorEnvelope ===
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|<code>error</code>
|Error
| -
|}

=== Объект Error ===
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|<code>code</code>
|integer
|Код состояния HTTP
|-
|<code>constraintViolations</code>
|ConstraintViolation []
|Список нарушений ограничений
|-
|<code>message</code>
|string
|Сообщение об ошибке
|}

=== Объект ConstraintViolation ===
Список нарушений ограничений
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|<code>location</code>
|string
| -
|-
|<code>message</code>
|string
| -
|-
|<code>parameterLocation</code>
|string
| -
Этот элемент может содержать следующие значения: <code>HEADER</code>, <code>PATH</code>, <code>PAYLOAD_BODY</code>, <code>QUERY</code>
|-
|<code>path</code>
|string
| -
|}

== Модели JSON тела ответа ==

=== Успешный ответ ===
{| class="wikitable"
|<pre>
{
  "availableVersions": [
    "string"
  ]
}
</pre>
|}

=== Ответ с ошибкой ===
{| class="wikitable"
|<pre>
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}
</pre>
|}