Получение всех конфигураций мониторинга: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| (не показаны 4 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
Список всех конфигураций мониторинга указанного расширения Extensions 2.0. | Список всех конфигураций мониторинга указанного расширения Extensions 2.0. | ||
Запрос создает <code>application/json</code> | Запрос создает в качестве полезной нагрузки<code>application/json</code> формат. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |GET | ||
|Managed | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations</nowiki></code> | ||
|} | |} | ||
| Строка 22: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
|nextPageKey | |nextPageKey | ||
| Строка 32: | Строка 29: | ||
Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. | Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| Строка 42: | Строка 39: | ||
Если не установлено, используется 20. | Если не установлено, используется 20. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| Строка 48: | Строка 45: | ||
|string | |string | ||
|Имя запрошенного расширения 2.0. | |Имя запрошенного расширения 2.0. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| Строка 54: | Строка 51: | ||
|string | |string | ||
|Фильтрует результирующий набор конфигураций по версии расширения 2.0. | |Фильтрует результирующий набор конфигураций по версии расширения 2.0. | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| Строка 60: | Строка 57: | ||
|boolean | |boolean | ||
|Фильтрует результирующий набор конфигураций по активному состоянию. | |Фильтрует результирующий набор конфигураций по активному состоянию. | ||
| | |query | ||
|по желанию | |по желанию | ||
|} | |} | ||
| Строка 87: | Строка 84: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>ExtensionMonitoringConfigurationsList</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
| Строка 112: | Строка 109: | ||
|} | |} | ||
==== Объект | ==== Объект <code>ExtensionMonitoringConfiguration</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
Текущая версия на 16:02, 26 октября 2022
Список всех конфигураций мониторинга указанного расширения Extensions 2.0.
Запрос создает в качестве полезной нагрузкиapplication/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение конфигураций мониторинга расширений ( extensionConfigurations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.
Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса. |
query | по желанию |
| pageSize | integer | Количество расширений в полезной нагрузке одного ответа.
Максимально допустимый размер страницы — 100. Если не установлено, используется 20. |
query | по желанию |
| extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
| version | string | Фильтрует результирующий набор конфигураций по версии расширения 2.0. | query | по желанию |
| active | boolean | Фильтрует результирующий набор конфигураций по активному состоянию. | query | по желанию |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | ExtensionMonitoringConfigurationsList | Успех |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
| 404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ExtensionMonitoringConfigurationsList
| Элемент | Тип | Описание |
|---|---|---|
| items | ExtensionMonitoringConfiguration[] | Список конфигураций мониторинга расширений. |
| totalCount | integer | Общее количество записей в результате. |
| pageSize | integer | Количество записей на странице. |
| nextPageKey | string | Курсор для следующей страницы результатов. Имеет значение nullна последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. |
Объект ExtensionMonitoringConfiguration
| Элемент | Тип | Описание |
|---|---|---|
| objectId | string | Идентификатор конфигурации |
| scope | string | Объем конфигурации |
| value | string | Конфигурация |
JSON-модель тела ответа
{
"items": [
{
"objectId": "string",
"scope": "string",
"value": "string"
}
],
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ=="
}
