Установка конфигурации мониторинга

Материал из Документация Ключ-АСТРОМ


Обновляет указанную конфигурацию мониторинга расширения Extensions 2.0.

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

PUT Managed https://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
SaaS https://{your-environment-id}.live.ruscomtech.ru/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}
Окружающая среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}

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

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

Параметры

Параметр Тип Описание In Необходимый
extensionName string Имя запрошенного расширения 2.0. path требуется
configurationId string Идентификатор запрошенной конфигурации мониторинга. path требуется
body MonitoringConfigurationUpdateDto Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. body требуется

Объекты тела запроса

Объект MonitoringConfigurationUpdateDto

Элемент Тип Описание Необходимость
value JsonNode Конфигурация мониторинга по желанию

Объект JsonNode

Конфигурация мониторинга

Объект не предоставляет никаких параметров.

JSON-модель тела запроса

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

{
  "value": {}
}

Ответ

Коды ответов

Код Тип Описание
200 MonitoringConfigurationResponse Успех
400 ErrorEnvelope Не удалось. Ввод недействителен.
404 ErrorEnvelope Не удалось. Запрошенный ресурс не существует.

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

Объект MonitoringConfigurationResponse

Элемент Тип Описание
objectId string Идентификатор новой конфигурации
code integer Код состояния HTTP

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

{
  "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "code": 1
}