Размещение конфигурации мониторинга
Материал из Документация Ключ-АСТРОМ
Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0.
Запрос создает и использует в качестве полезной нагрузки application/json
формат.
POST | 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.write
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
extensionName | string | Имя запрошенного расширения 2.0. | path | требуется |
body | MonitoringConfigurationDto[] | Тело запроса в формате JSON, содержащее параметры конфигурации мониторинга. | body | требуется |
Объекты тела запроса
Объект RequestBody
Объект не предоставляет никаких параметров.
Объект MonitoringConfigurationDto
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
scope | string | Область, для которой будет определена эта конфигурация мониторинга | требуется |
value | JsonNode | Конфигурация мониторинга | по желанию |
Объект JsonNode
Конфигурация мониторинга
Объект не предоставляет никаких параметров.
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
[
{
"scope": "HOST-D3A3C5A146830A79",
"value": {}
}
]
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | MonitoringConfigurationResponse[] | Успех |
207 | MonitoringConfigurationResponse | Мультистатус, если не все запросы привели к одному и тому же статусу |
404 | ErrorEnvelope | Не удалось. Запрошенный ресурс не существует. |
Объекты тела ответа
Объект ResponseBody
Объект не предоставляет никаких параметров.
Объект MonitoringConfigurationResponse
Элемент | Тип | Описание |
---|---|---|
objectId | string | Идентификатор новой конфигурации |
code | integer | Код состояния HTTP |
JSON-модель тела ответа
[
{
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
"code": 1
}
]