ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 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%D1%85%D0%B5%D0%BC%D1%8B%20%D1%80%D0%B0%D1%81%D1%88%D0%B8%D1%80%D0%B5%D0%BD%D0%B8%D1%8F-,%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%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D0%B8%D0%BD%D0%B3%D0%B0,-GET%20%D0%B2%D1%81%D0%B5%D1%85%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D0%B9 Конфигурации мониторинга] / POST конфигурации мониторинга''''' | ||
Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0. | Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0. | ||
| Строка 7: | Строка 7: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |POST | | rowspan="2" |POST | ||
| | |АппОптима | ||
|<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> | ||
|- | |- | ||
| Строка 61: | Строка 61: | ||
===JSON-модель тела запроса=== | ===JSON-модель тела запроса=== | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <[ | ||
{ | { | ||
"scope": "HOST-D3A3C5A146830A79", | "scope": "HOST-D3A3C5A146830A79", | ||
"value": {} | "value": {} | ||
} | } | ||
] | ] | ||
==Ответ== | ==Ответ== | ||
===Коды ответов=== | ===Коды ответов=== | ||
| Строка 104: | Строка 104: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <[ | ||
{ | { | ||
"objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", | "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=", | ||
"code": 1 | "code": 1 | ||
} | } | ||
] | ] | ||
Текущая версия от 14:31, 24 декабря 2024
API АппОптима / Эндпойнты среды / Развёртывание / Расширения 2.0 / Конфигурации мониторинга / POST конфигурации мониторинга
Создает новую конфигурацию мониторинга для указанного расширения Extensions 2.0.
Запрос создает и использует в качестве полезной нагрузки application/json формат.
| POST | АппОптима | 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
}
]