POST пакетное выполнение

Материал из Документация Ключ-АСТРОМ
Версия от 12:50, 21 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Запускает пакетное выполнение синтетических мониторов. Запрос создает и использует в к...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Запускает пакетное выполнение синтетических мониторов.

Запрос создает и использует в качестве полезной нагрузки application/json формат.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/executions/batch
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/executions/batch

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

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

Параметры

Параметр Тип Описание In Необходимость
body SyntheticOnDemandExecutionRequest Тело JSON запроса. Содержит параметры инициированного выполнения по требованию. body по желанию

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

Объект SyntheticOnDemandExecutionRequest

Содержит параметры для запуска по запросу мониторов, идентифицированных тегами, приложениями или службами.

Элемент Тип Описание Необходимость
processingMode string Режим обработки выполнения

Элемент может содержать эти значения

  • STANDARD
  • DISABLE_PROBLEM_DETECTION
  • EXECUTIONS_DETAILS_ONLY
по желанию
failOnPerformanceIssue boolean Если true, статус будет FAILED в случае проблем с производительностью. по желанию
stopOnProblem boolean Если true, выполнение не будет запланировано в случае возникновения проблемы. по желанию
monitors SyntheticOnDemandExecutionRequestMonitor[] Список мониторов, которые будут активированы. по желанию
group SyntheticOnDemandExecutionRequestGroup Содержит параметры для запуска по запросу мониторов, идентифицированных тегами, приложениями или службами. по желанию

Объект SyntheticOnDemandExecutionRequestMonitor

Содержит мониторы, запускаемые по запросу из указанных местоположений.

Элемент Тип Описание Необходимость
monitorId string Идентификатор монитора требуется
locations string [] Места, из которых должен выполняться монитор. по желанию

Объект SyntheticOnDemandExecutionRequestGroup

Содержит параметры для запуска по запросу мониторов, идентифицированных тегами, приложениями или службами.

Элемент Тип Описание Необходимость
tags string[] Список тегов. Будут выполняться только мониторы со всеми назначенными тегами. по желанию
applications string[] Список идентификаторов приложений. Будут выполняться только мониторы со всеми назначенными приложениями. по желанию
services string[] Список идентификаторов услуг. Будут выполняться только мониторы со всеми назначенными службами. по желанию
locations string[] Места, откуда должны выполняться мониторы. по желанию

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

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

{
  "processingMode": "EXECUTIONS_DETAILS_ONLY",
  "failOnPerformanceIssue": "false",
  "stopOnProblem": "true",
  "monitors": [
    {
      "monitorId": "HTTP_CHECK-6349B98E1CD87352",
      "locations": [
        "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
        "SYNTHETIC_LOCATION-ACCA399FAA1194DD"
      ]
    }
  ],
  "group": {
    "applications": [
      "APPLICATION-CD4BEF05FA9DD044"
    ],
    "services": [
      "SERVICE-01C6C1282960638B",
      "SERVICE-B18840B4E3115C1A"
    ],
    "tags": [
      "tag-production",
      "another-tag"
    ]
  }
}

Ответ

Коды ответов

Код Тип Описание
201 SyntheticOnDemandExecutionResult Успех. Детали ответа монитора на выполнение

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

Объект SyntheticOnDemandExecutionResult

Результат выполнения синтетического монитора по требованию.

Элемент Тип Описание
batchId string Идентификатор пакета запущенных исполнений.
triggeringProblemsCount integer Общее количество проблем в пакете.
triggeringProblemsDetails SyntheticOnDemandTriggeringProblemDetails[] Список с объектами, для которых возникли проблемы с запуском.
triggeredCount integer Общее количество инициированных исполнений в пакете.
triggered SyntheticOnDemandTriggeredMonitor[] Мониторы, для которых были инициированы выполнения по требованию.

Объект SyntheticOnDemandTriggeringProblemDetails

Содержит сведения о проблемах, возникших при запуске выполнения по требованию.

Элемент Тип Описание
entityId string Идентификатор объекта.
locationId string Идентификатор местоположения.
cause string Причина не запуска сущности.

Объект SyntheticOnDemandTriggeredMonitor

Содержит список запусков монитора по запросу.

Элемент Тип Описание
monitorId string Идентификатор монитора.
executions SyntheticOnDemandTriggeredExecutionDetails[] Список инициированных выполнений.

Объект SyntheticOnDemandTriggeredExecutionDetails

Содержит сведения о запущенном выполнении по требованию.

Элемент Тип Описание
executionId string Идентификатор выполнения.
locationId string Идентификатор места, из которого должен выполняться монитор.

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

{
  "batchId": "22396514015719218",
  "triggeringProblemsCount": 4,
  "triggeringProblemsDetails": [
    {
      "entityId": "HTTP_CHECK-6349B98E1CD87352",
      "locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA",
      "cause": "Location not found"
    },
    {
      "entityId": "HTTP_CHECK-6349B98E1CD85432",
      "cause": "Monitor not found"
    },
    {
      "entityId": "HTTP_HACK-AAAAAAA",
      "cause": "Incorrect monitor identifier format"
    },
    {
      "entityId": "APPLICATION-WRONG",
      "cause": "Incorrect application identifier format"
    }
  ],
  "triggeredCount": 1,
  "triggered": [
    {
      "monitorId": "HTTP_CHECK-69A9B98E1CD87352",
      "executions": [
        {
          "executionId": "1069999568093682590",
          "locationId": "SYNTHETIC_LOCATION-9BB04DAE11123122"
        }
      ]
    }
  ]
}