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

Материал из Документация Ключ-АСТРОМ

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

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

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

GET

SaaS: https://{your-environment-id}.live.astromkey.com/api/v1/deployment/installer/agent/versions/{osType}/{installerType}

GET

Среда Активного Шлюза: https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/deployment/installer/agent/versions/{osType}/{installerType}

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

Для выполнения этого запроса вам потребуется токен доступа с областью действия InstallerDownload.

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

Параметры

Параметр Тип Описание В Необходимый
osType string Операционная система установщика. Этот элемент может содержать следующие значения: AIX, LINUX, SOLARIS, WINDOWS, ZOS. path Необходимый
installerType string Тип установщика:
  • default: Самораспаковывающийся установщик для ручной установки. Загружает .exe файл для Windows или .sh файл для Unix.
  • default-unattended: Самораспаковывающийся установщик для автоматической установки. Только для Windows. Загружает .zip архив, содержащий .msi установщик и пакетный файл. Эта опция устарела в версии ЕдиныйАгент 1.173.
  • mainframe: Загружает все модули кода для z/OS, объединенные в один *.pax архив.
  • paas: Установщик модулей кода. Загружает *.zip архив, содержащий manifest.json файл с метаинформацией или .jar файл для z/OS.
  • paas-sh: Установщик модулей кода. Загружает самораспаковывающийся скрипт оболочки со встроенным tar.gz архивом.Этот элемент может содержать следующие значения: default, default-unattended, mainframe, paas, paas-sh.
 path Необходимый
flavor string Тип вашей дистрибуции Linux:
  • musl для дистрибутивов Linux, использующих стандартную библиотеку C musl, например, Alpine Linux.
  • multidistro для дистрибутивов Linux, использующих стандартные библиотеки musl C и glibc.
  • default для дистрибутивов Linux, использующих стандартную библиотеку glibc.

Применимо только к типам установщиков paas и paas-sh. Этот элемент может содержать следующие значения: default, multidistro, musl.

query Необязательный
arch string Архитектура вашей операционной системы:
  • all Используйте это значение для AIX и z/OS. x86 Для других типов ОС по умолчанию используется значение по умолчанию.
  • x86 Архитектура x86.
  • ppc Архитектура PowerPC, поддерживается только для AIX.
  • ppcle Архитектура PowerPC Little Endian, поддерживается только в Linux.
  • sparc Архитектура Sparc, поддерживается только для Solaris.
  • arm Архитектура ARM, поддерживается только в Linux.
  • s390 Архитектура S/390, поддерживается только для Linux.

Применимо только к типам установщиков paas и paas-sh. Этот элемент может содержать следующие значения: all, arm, ppc, ppcle, s390, sparc, x86.

query Необязательный

Ответ

Коды ответов

Код Тип Описание
200 Версии установщика агента Успех. Полезная нагрузка содержит доступные версии.
4XX Оболочка ошибки Ошибка на стороне клиента.
5XX Оболочка ошибки Ошибка на стороне сервера.

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

Объект AgentInstallerVersions

Список доступных версий установщика ЕдиногоАгента.

Элемент Тип Описание
availableVersions string [] Список доступных версий установщика ЕдиногоАгента.

Объект ErrorEnvelope

Элемент Тип Описание
error Error -

Объект Error

Элемент Тип Описание
code integer Код состояния HTTP
constraintViolations ConstraintViolation [] Список нарушений ограничений
message string Сообщение об ошибке

Объект ConstraintViolation

Список нарушений ограничений

Элемент Тип Описание
location string -
message string -
parameterLocation string -

Этот элемент может содержать следующие значения: HEADER, PATH, PAYLOAD_BODY, QUERY

path string -

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

Успешный ответ

{
  "availableVersions": [
    "string"
  ]
}

Ответ с ошибкой

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}
Источник — https://doc.ruscomtech.ru/index.php?title=API_развертывания_—_Список_доступных_версий_ЕдиногоАгента&oldid=6514