ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
(не показаны 2 промежуточные версии этого же участника) | |||
Строка 1: | Строка 1: | ||
'''''[[API | '''''[[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=GET%20%D1%81%D0%B2%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D1%8F-,%D0%A0%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F%202.0,-%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B8%20%D1%81%D1%80%D0%B5%D0%B4%D1%8B Расширения 2.0] / [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=GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0%20%D1%81%D0%BE%D0%B1%D1%8B%D1%82%D0%B8%D0%B9-,%D0%A0%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F,-GET%20%D0%B2%D1%81%D0%B5%D1%85%20%D1%80%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D0%B9 Расширения] / GET всех расширений''''' | ||
Функция возвращает список всех расширений Extensions 2.0, доступных в вашей среде | Функция возвращает список всех расширений Extensions 2.0, доступных в вашей среде АппОптима . | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |GET | | rowspan="2" |GET | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions</nowiki></code> | ||
|- | |- | ||
Строка 104: | Строка 104: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <{ | ||
"extensions": [ | "extensions": [ | ||
{ | { | ||
Строка 114: | Строка 114: | ||
"pageSize": 1, | "pageSize": 1, | ||
"nextPageKey": "AQAAABQBAAAABQ==" | "nextPageKey": "AQAAABQBAAAABQ==" | ||
} | } |
Текущая версия от 14:24, 24 декабря 2024
API АппОптима / Эндпойнты среды / Развёртывание / Расширения 2.0 / Расширения / GET всех расширений
Функция возвращает список всех расширений Extensions 2.0, доступных в вашей среде АппОптима .
Запрос создает application/json
полезную нагрузку.
GET | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/extensions
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Read extensions ( extensions.read
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
запрос | по желанию |
pageSize | integer | Количество расширений в полезной нагрузке одного ответа.
Максимально допустимый размер страницы — 100. Если не установлено, используется 20. |
запрос | по желанию |
name | string | Фильтрует полученный набор расширений 2.0 по имени. Вы можете указать частичное имя. В этом случае используется оператор CONTAINS. | запрос | по желанию |
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | Список расширений | Успех |
Объекты тела ответа
Объект ResponseBody
Элемент | Тип | Описание |
---|---|---|
pageSize | MinimalExtension[] | Список расширений.
Может быть |
totalCount | integer | Общее количество записей в результате. |
pageSize | integer | Количество записей на странице.
Может быть |
nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение null на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. Может быть |
Объект MinimalExtension
Список расширений.
Элемент | Тип | Описание |
---|---|---|
extensionName | string | Имя расширения
Может быть |
version | string | Версия расширения
Может быть |
JSON-модель тела ответа
<{ "extensions": [ { "extensionName": "string", "version": "1.2.3" } ], "totalCount": 1, "pageSize": 1, "nextPageKey": "AQAAABQBAAAABQ==" }