GET релизы

Список всех доступных выпусков.

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

GET	Managed	https://{your-domain}/e/{your-environment-id}/api/v2/releases
	Среда АктивногоШлюза	https://{your-activegate-domain}/e/{your-environment-id}/api/v2/releases

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

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

Параметры

Параметр	Тип	Описание	В	Необходимый
из	string	Начало запрошенного таймфрейма. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма: m: минут h: часы d: дней w: недели M: месяцы y: годы Если не задано, используется относительный двухнедельный таймфрейм ( now-2w).	запрос	по желанию
к	string	Конец запрошенного периода времени. Вы можете использовать один из следующих форматов: Отметка времени в миллисекундах UTC. Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными. Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма: m: минут h: часы d: дней w: недели M: месяцы y: годы Если не установлено, используется текущая метка времени.	запрос	по желанию
ключ следующей страницы	string	Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.	запрос	по желанию
размер страницы	string	Количество релизов в полезной нагрузке одного ответа. Максимально допустимый размер страницы — 1000. Если не установлено, используется 100.	запрос	по желанию
демо	логический	Получите ваши Релизы ( false) или набор демонстрационных Релизов ( true).	запрос	по желанию
релизыСелектор	string	Определяет область запроса. В ответ включаются только Релизы, соответствующие указанным критериям. Вы можете добавить один или несколько из перечисленных ниже критериев. Зона управления: тип(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Фильтры для всех выпусков в данной зоне управления. Фильтр чувствителен к регистру. Состояние мониторинга: MonitoringState("Активно") или MonitoringState("Неактивно"). Вы можете указать только одно состояние мониторинга. Состояние работоспособности: HealthState("ЗДОРОВО") или HealthState("НЕЗДОРОВО"). Можно указать только одно состояние работоспособности. Уязвимость системы безопасности: затронутаяBySecurityProblem("Обнаружена") или затронутаяBySecurityProblem("Не обнаружена"). Вы можете указать только одно состояние уязвимости безопасности. Имя: имя_сущности("имя"). Фильтры для всех выпусков, которые содержат данное значение в своем имени. Фильтр нечувствителен к регистру. Идентификатор объекта: entityId("id"). Продукт: ReleasesProduct("продукт"). Фильтры для всех выпусков, которые содержат данное значение в своем продукте. Фильтр нечувствителен к регистру. Стадия: releasesStage("этап"). Фильтры для всех выпусков, которые содержат данное значение на своем этапе. Фильтр нечувствителен к регистру. Версия: ReleasesVersion("версия"). Фильтры для всех выпусков, которые содержат данное значение в своей версии. Фильтр нечувствителен к регистру. Чтобы задать несколько критериев, разделите их запятой (,). В ответ включаются только результаты, соответствующие всем критериям. например, .../api/v2/releases?releasesSelector=name("Сервер"),monitoringState("Активный"),healthState("ЗДОРОВЫЙ"),releasesVersion("1.0.7"). Специальные символы ~ и " необходимо экранировать с помощью символа ~ (например, поиск в двойных кавычках entityName("~"")).	запрос	по желанию
Сортировать	string	Указывает поле, используемое для сортировки списка релизов. Поле имеет знаковый префикс (+/-), который соответствует порядку сортировки («+» по возрастанию и «-» по убыванию). Если префикс знака не установлен, будет применяться порядок сортировки по возрастанию по умолчанию. Вы можете сортировать по следующим свойствам: 'продукт': название продукта 'имя': название выпуска 'стадия': сценическое имя 'версия': версия 'экземпляры': экземпляры 'трафик': Трафик Если не задано, применяется сортировка имени по возрастанию.	запрос	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	Релизы	Успех
400	ErrorEnvelope	Не удалось. Ввод недействителен.

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

Объект _ Releases

Список релизов.

Элемент	Тип	Описание
выпускает	Выпустить []	Список релизов.
релизыWithProblems	string	Количество релизов с проблемами.
размер страницы	string	Количество записей на странице.
ключ следующей страницы	string	Курсор для следующей страницы результатов. Имеет значение nullна последней странице. Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
общее количество	string	Общее количество записей в результате.

Объект _ Release

Содержит данные, относящиеся к одному выпуску компонента. Релиз — это комбинация компонента и версии. Компонент может быть любой формой развертывания, которая может быть связана с версией. В первом наброске Компонент всегда является Сервисом.

Кортеж <name, product, stage, version> всегда уникален.

Элемент	Тип	Описание
securityVulnerabilitiesCount	string	Количество уязвимостей безопасности объекта
ReleaseEntityId	string	Идентификатор объекта коррелирующего выпуска.
пропускная способность	количество	Количество байтов в секунду объекта
securityVulnerabilitiesEnabled	логический	Указывает, что функция уязвимостей безопасности включена.
затронутыеBySecurityVulnerabilities	логический	Объект имеет одну или несколько уязвимостей безопасности
программное обеспечениеTechs	Специалисты по программному обеспечению [ ]	Программные технологии выпуска
затронутоByProblems	логический	У организации есть одна или несколько проблем
товар	string	Название продукта
экземпляры	Выпустить экземпляр []	Экземпляры entityId, включенные в этот выпуск
Бег	логический	Соответствующий PGI все еще работает/отслеживается
имя	string	Имя объекта
версия	string	Идентифицированная версия выпуска
проблемаКоличество	string	Количество проблем организации
сцена	string	Сценическое имя

Объект _ SoftwareTechs

Содержит информацию об используемой программной технологии.

Элемент	Тип	Описание
технологии	string	Тип технологии.
версия	string	Издание техники.
verbatimType	string	Дословный тип технологии.
версия	string	Версия технологии.

Объект _ ReleaseInstance

Содержит данные, относящиеся к одному экземпляру выпуска. Экземпляр является экземпляром группы процессов и имеет необязательную версию сборки.

Элемент	Тип	Описание
версия сборки	string	Версия сборки
безопасностьУязвимости	string []	Список идентификаторов уязвимостей безопасности
идентификатор объекта	string	Идентификатор сущности экземпляра.
проблемы	string []	Список идентификаторов событий открытых проблем

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

{
  "releases": [
    {
      "securityVulnerabilitiesCount": 4,
      "releaseEntityId": "PROCESS_GROUP-DFDBAC9CBF104253",
      "throughput": 923234,
      "securityVulnerabilitiesEnabled": true,
      "affectedBySecurityVulnerabilities": true,
      "softwareTechs": [
        {
          "technology": "JAVA",
          "edition": "OpenJDK",
          "version": "1.8.0_242",
          "verbatimType": "Java"
        }
      ],
      "affectedByProblems": true,
      "product": "Sockshop",
      "instances": [
        "PROCESS_GROUP_INSTANCE-49D94B90FB71C45B",
        "PROCESS_GROUP_INSTANCE-7EA049157C82D1A5"
      ],
      "running": true,
      "name": "cluster",
      "version": "1.195.34.12341232423-012342",
      "problemCount": 4,
      "stage": "staging"
    }
  ],
  "releasesWithProblems": 1,
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "totalCount": 1
}