POST прочие события
Передает информацию о сторонних синтетических событиях в Ключ-АСТРОМ.
Запрос использует в качестве полезной нагрузки application/json
формат.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/events
|
Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/ext/events
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( ExternalSyntheticIntegration
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
body | 3rdPartySyntheticEvents | Тело JSON запроса. Содержит сторонние синтетические события. | body | требуется |
Объекты тела запроса
Объект 3rdPartySyntheticEvents
Список сторонних синтетических событий.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
syntheticEngineName | string | Тип стороннего синтетического монитора. | требуется |
open | 3rdPartyEventOpenNotification[] | Список открытых сторонних синтетических событий. | по желанию |
resolved | 3rdPartyEventResolvedNotification[] | Список закрытых сторонних синтетических событий. | по желанию |
Объект 3rdPartyEventOpenNotification
Открытое стороннее синтетическое событие.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
testId | string | Идентификатор стороннего синтетического монитора. | требуется |
eventId | string | Уникальный идентификатор события. | требуется |
name | string | Название события. | требуется |
eventType | string | Тип события.
Элемент может содержать эти значения
|
требуется |
reason | string | Причина события. | требуется |
startTimestamp | integer | Отметка времени начала события в миллисекундах UTC. | требуется |
locationIds | string[] | Список идентификаторов сторонних синтетических локаций, где происходит событие. | требуется |
Объект 3rdPartyEventResolvedNotification
Закрытое стороннее синтетическое мероприятие.
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
testId | string | Идентификатор стороннего синтетического монитора. | требуется |
eventId | string | Уникальный идентификатор события. | требуется |
endTimestamp | integer | Отметка времени окончания события в миллисекундах UTC. | требуется |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"syntheticEngineName": "string",
"open": [
{
"testId": "string",
"eventId": "string",
"name": "string",
"eventType": "testOutage",
"reason": "string",
"startTimestamp": 1,
"locationIds": [
"string"
]
}
],
"resolved": [
{
"testId": "string",
"eventId": "string",
"endTimestamp": 1
}
]
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
204 | Успех. Информация принимается и сохраняется. | |
400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Обновите существующий сторонний монитор
Чтобы обновить существующий сторонний монитор, укажите его движок в поле syntheticEngineName3rdPartySyntheticTests
объекта и его ID в поле id3rdPartySyntheticTest
объекта.
Вы должны представить все параметры монитора. Не изменяйте значения параметров, которые вы не хотите изменять.
Пример
В этом примере запрос добавляет в пример синтетического монитора событие отключения — 1 сторонний синтетический монитор из POST прочие мониторы в Ключ-АСТРОМ .
Маркер API передается в заголовке авторизации .
Вы можете загрузить тело запроса в формате JSON, чтобы выполнить образец запроса в своей среде. Обязательно замените временные метки на недавние, иначе результаты будут слишком старыми.
Curl
curl -X POST \
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/events \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{<truncated - see the Request body section below>}
'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/ext/events
Тело запроса
{
"syntheticEngineName": "My third-party synthetic",
"open": [
{
"testId": "3rdPartySyntheticMonitor1",
"eventId": "extOpenEvent1-1",
"name": "example of event",
"reason": "sample outage",
"eventType": "testOutage",
"locationIds": ["Linz1"],
"startTimestamp": 1543582285957
}
],
"resolved": []
}
Код ответа
204
Результат
Подсветка показывает параметры, представленные в запросе.