ENetrebin (обсуждение | вклад) (Новая страница: «Изменяет рабочее состояние всех сторонних мониторов. Запрос использует в качестве поле...») |
Нет описания правки |
||
| (не показана 1 промежуточная версия этого же участника) | |||
| Строка 1: | Строка 1: | ||
'''''[[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%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / [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%D0%BD%D0%BE%D0%B4%D0%B0-,%D0%9F%D1%80%D0%BE%D1%87%D0%B0%D1%8F%20%D1%81%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0,-POST%20%D0%BF%D1%80%D0%BE%D1%87%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Прочая синтетика] / POST изменение состояния прочих мониторов''''' | |||
Изменяет рабочее состояние всех сторонних мониторов. | Изменяет рабочее состояние всех сторонних мониторов. | ||
| Строка 4: | Строка 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |POST | | rowspan="2" |POST | ||
| | |АппОптима | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications</nowiki></code> | ||
|- | |- | ||
| Строка 53: | Строка 55: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"state": "ACTIVE" | "state": "ACTIVE" | ||
} | } | ||
== Ответ == | == Ответ == | ||
| Строка 80: | Строка 82: | ||
==== Завиток ==== | ==== Завиток ==== | ||
< | <curl -X POST \ | ||
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/stateModifications</nowiki> \ | <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/stateModifications</nowiki> \ | ||
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \ | ||
| Строка 87: | Строка 89: | ||
"state": "ACTIVE" | "state": "ACTIVE" | ||
} | } | ||
' | ' | ||
==== URL-адрес запроса ==== | ==== URL-адрес запроса ==== | ||
| Строка 93: | Строка 95: | ||
==== Тело запроса ==== | ==== Тело запроса ==== | ||
< | <{ | ||
"state": "ACTIVE" | "state": "ACTIVE" | ||
} | } | ||
==== Код ответа ==== | ==== Код ответа ==== | ||
204 | 204 | ||
Текущая версия от 17:15, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v1 / Прочая синтетика / POST изменение состояния прочих мониторов
Изменяет рабочее состояние всех сторонних мониторов.
Запрос использует в качестве полезной нагрузки application/json формат.
| POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( ExternalSyntheticIntegration) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| body | StateModification | Тело JSON запроса. Содержит новый рабочий статус сторонних синтетических мониторов. | body | требуется |
Объекты тела запроса
Объект StateModification
Рабочее состояние будет установлено для всех синтетических мониторов сторонних производителей.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| state | string | Новое рабочее состояние для всех сторонних синтетических мониторов.
Элемент может содержать эти значения
|
требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"state": "ACTIVE"
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | Успех. Изменено состояние сторонних мониторов. | |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Пример
В этом примере запрос устанавливает состояние сторонних мониторов как активное .
Маркер API передается в заголовке авторизации .
Завиток
<curl -X POST \
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/stateModifications \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"state": "ACTIVE"
}
'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/stateModifications
Тело запроса
<{
"state": "ACTIVE"
}
Код ответа
204