IKuznetsov в 16:24, 2 января 2025

2025-01-02T16:24:04Z

← Предыдущая версия		Версия от 16:24, 2 января 2025
Строка 1:		Строка 1:

			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=POST%20%D0%B7%D0%B0%D0%BA%D1%80%D1%8B%D1%82%D0%B8%D0%B5%20%D0%BF%D1%80%D0%BE%D0%B1%D0%BB%D0%B5%D0%BC%D1%8B-,%D0%A0%D0%B5%D0%BB%D0%B8%D0%B7%D1%8B,-GET%20%D1%80%D0%B5%D0%BB%D0%B8%D0%B7%D1%8B Релизы] / GET релизы'''''

	Список всех доступных выпусков.		Список всех доступных выпусков.
Строка 325:		Строка 326:
	"nextPageKey": "AQAAABQBAAAABQ==",		"nextPageKey": "AQAAABQBAAAABQ==",
	"totalCount": 1		"totalCount": 1
	}~~</code>~~		}

IKuznetsov в 09:37, 26 декабря 2024

2024-12-26T09:37:39Z

← Предыдущая версия		Версия от 09:37, 26 декабря 2024
Строка 6:		Строка 6:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/releases</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/releases</nowiki></code>
	\|-		\|-
Строка 292:		Строка 292:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"releases": [		"releases": [
	{		{

ENetrebin: /* Параметры */

2022-10-18T14:31:54Z

Параметры

Внесённые изменения

ENetrebin в 12:44, 17 октября 2022

2022-10-17T12:44:59Z

Внесённые изменения

ENetrebin: Новая страница: « Список всех доступных выпусков. Запрос создает `application/json`полезную нагрузку. {| class...»

2022-10-17T12:42:18Z

Новая страница: « Список всех доступных выпусков. Запрос создает <code>application/json</code>полезную нагрузку. {| class...»

Новая страница

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/releases</nowiki></code>
|-
|SaaS
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/releases</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/releases</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|из
|нить
|Начало запрошенного таймфрейма.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минут
** <code>h</code>: часы
** <code>d</code>: дней
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не задано, используется относительный двухнедельный таймфрейм ( <code>now-2w</code>).
|запрос
|по желанию
|-
|к
|нить
|Конец запрошенного периода времени.

Вы можете использовать один из следующих форматов:

* Отметка времени в миллисекундах UTC.
* Человекочитаемый формат <code>2021-01-25T05:57:01.123+01:00</code>. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо <code>T</code>. Секунды и доли секунды не являются обязательными.
* Относительный таймфрейм, назад. Формат: <code>now-NU/A</code>, где <code>N</code>количество времени, <code>U</code>единица времени и <code>A</code>выравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, <code>now-1y/w</code>это один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: <code>now-NU</code>. Поддерживаемые единицы времени для относительного таймфрейма:
** <code>m</code>: минут
** <code>h</code>: часы
** <code>d</code>: дней
** <code>w</code>: недели
** <code>M</code>: месяцы
** <code>y</code>: годы

Если не установлено, используется текущая метка времени.
|запрос
|по желанию
|-
|ключ следующей страницы
|нить
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|запрос
|по желанию
|-
|размер страницы
|целое число
|Количество релизов в полезной нагрузке одного ответа.

Максимально допустимый размер страницы — 1000.

Если не установлено, используется 100.
|запрос
|по желанию
|-
|демо
|логический
|Получите ваши Релизы ( <code>false</code>) или набор демонстрационных Релизов ( <code>true</code>).
|запрос
|по желанию
|-
|релизыСелектор
|нить
|Определяет область запроса. В ответ включаются только Релизы, соответствующие указанным критериям.

Вы можете добавить один или несколько из перечисленных ниже критериев.

* Зона управления: тип(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("~"")).
|запрос
|по желанию
|-
|Сортировать
|нить
|Указывает поле, используемое для сортировки списка релизов. Поле имеет знаковый префикс (+/-), который соответствует порядку сортировки («+» по возрастанию и «-» по убыванию). Если префикс знака не установлен, будет применяться порядок сортировки по возрастанию по умолчанию. Вы можете сортировать по следующим свойствам:

* 'продукт': название продукта
* 'имя': название выпуска
* 'стадия': сценическое имя
* 'версия': версия
* 'экземпляры': экземпляры
* 'трафик': Трафик

Если не задано, применяется сортировка имени по возрастанию.
|запрос
|по желанию
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Релизы
|Успех
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|}

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

==== Объект _ <code>Releases</code> ====
Список релизов.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|выпускает
|Выпустить []
|Список релизов.
|-
|релизыWithProblems
|целое число
|Количество релизов с проблемами.
|-
|размер страницы
|целое число
|Количество записей на странице.
|-
|ключ следующей страницы
|нить
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|общее количество
|целое число
|Общее количество записей в результате.
|}

==== Объект _ <code>Release</code> ====
Содержит данные, относящиеся к одному выпуску компонента. Релиз — это комбинация компонента и версии. Компонент может быть любой формой развертывания, которая может быть связана с версией. В первом наброске Компонент всегда является Сервисом.

Кортеж <name, product, stage, version> всегда уникален.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|securityVulnerabilitiesCount
|целое число
|Количество уязвимостей безопасности объекта
|-
|ReleaseEntityId
|нить
|Идентификатор объекта коррелирующего выпуска.
|-
|пропускная способность
|количество
|Количество байтов в секунду объекта
|-
|securityVulnerabilitiesEnabled
|логический
|Указывает, что функция уязвимостей безопасности включена.
|-
|затронутыеBySecurityVulnerabilities
|логический
|Объект имеет одну или несколько уязвимостей безопасности
|-
|программное обеспечениеTechs
|Специалисты по программному обеспечению [ ]
|Программные технологии выпуска
|-
|затронутоByProblems
|логический
|У организации есть одна или несколько проблем
|-
|товар
|нить
|Название продукта
|-
|экземпляры
|Выпустить экземпляр []
|Экземпляры entityId, включенные в этот выпуск
|-
|Бег
|логический
|Соответствующий PGI все еще работает/отслеживается
|-
|имя
|нить
|Имя объекта
|-
|версия
|нить
|Идентифицированная версия выпуска
|-
|проблемаКоличество
|целое число
|Количество проблем организации
|-
|сцена
|нить
|Сценическое имя
|}

==== Объект _ <code>SoftwareTechs</code> ====
Содержит информацию об используемой программной технологии.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|технологии
|нить
|Тип технологии.
|-
|версия
|нить
|Издание техники.
|-
|verbatimType
|нить
|Дословный тип технологии.
|-
|версия
|нить
|Версия технологии.
|}

==== Объект _ <code>ReleaseInstance</code> ====
Содержит данные, относящиеся к одному экземпляру выпуска. Экземпляр является экземпляром группы процессов и имеет необязательную версию сборки.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|версия сборки
|нить
|Версия сборки
|-
|безопасностьУязвимости
|строка []
|Список идентификаторов уязвимостей безопасности
|-
|идентификатор объекта
|нить
|Идентификатор сущности экземпляра.
|-
|проблемы
|строка []
|Список идентификаторов событий открытых проблем
|}

=== JSON-модель тела ответа ===
<code>{
"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
}</code>

GET релизы - История изменений

IKuznetsov в 16:24, 2 января 2025

IKuznetsov в 09:37, 26 декабря 2024

ENetrebin: /* Параметры */

ENetrebin в 12:44, 17 октября 2022

ENetrebin: Новая страница: « Список всех доступных выпусков. Запрос создает application/jsonполезную нагрузку. {| class...»

ENetrebin: Новая страница: « Список всех доступных выпусков. Запрос создает `application/json`полезную нагрузку. {| class...»