Получение всех конфигураций мониторинга: различия между версиями

Материал из Документация Ключ-АСТРОМ
(Создана пустая страница)
 
 
(не показано 6 промежуточных версий этого же участника)
Строка 1: Строка 1:
Список всех конфигураций мониторинга указанного расширения Extensions 2.0.


Запрос создает в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<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>extensionConfigurations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!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
|по желанию
|}
== Ответ ==
=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|ExtensionMonitoringConfigurationsList
|Успех
|-
|400
|ErrorEnvelope
|Не удалось. Ввод недействителен.
|-
|404
|ErrorEnvelope
|Не удалось. Запрошенный ресурс не существует.
|}
=== Объекты тела ответа ===
==== Объект  <code>ExtensionMonitoringConfigurationsList</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|items
|ExtensionMonitoringConfiguration[]
|Список конфигураций мониторинга расширений.
|-
|totalCount
|integer
|Общее количество записей в результате.
|-
|pageSize
|integer
|Количество записей на странице.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|}
==== Объект  <code>ExtensionMonitoringConfiguration</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|objectId
|string
|Идентификатор конфигурации
|-
|scope
|string
|Объем конфигурации
|-
|value
|string
|Конфигурация
|}
=== JSON-модель тела ответа ===
<code>{
  "items": [
    {
      "objectId": "string",
      "scope": "string",
      "value": "string"
    }
  ],
  "totalCount": 1,
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ=="
}</code>

Текущая версия на 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=="
}
Источник — https://doc.ruscomtech.ru/index.php?title=Получение_всех_конфигураций_мониторинга&oldid=1901