POST локация*
Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтетического местоположения см. в разделе Создание частного искусственного местоположения .
Запрос создаёт и потребляет в качестве полезной нагрузкиapplication/json
формат.
POST | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations
|
Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( ExternalSyntheticIntegration
) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметр
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
Параметр | Тип | Описание | In | Необходимость |
---|---|---|---|---|
body | SyntheticLocation | Тело JSON запроса. Содержит параметры новой частной синтетической локации. | body | по желанию |
Объекты тела запроса
Объект SyntheticLocation
Конфигурация синтетической локации.
Параметры countryCode , regionCode , city являются необязательными, поскольку их можно получить на основе широты и долготы местоположения.
Фактический набор полей зависит от типа местоположения. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON .
Элемент | Тип | Описание | Необходимость |
---|---|---|---|
nodes | string[] | Список синтетических нод, принадлежащих локации.
Вы можете получить список доступных нод с помощью вызова GET all nodes . |
по желанию |
availabilityLocationOutage | boolean | Предупреждение об отключении местоположения включено ( true ) или отключено ( false ).
|
по желанию |
availabilityNodeOutage | boolean | Оповещение об отключении ноды включено ( true ) или отключено ( false ).
Если включено, сбой любой ноды в локации вызывает оповещение. |
по желанию |
locationNodeOutageDelayInMinutes | integer | Оповещение, если сбой местоположения или ноды длится дольше X минут.
Применимо только в том случае, если для параметра availabilityLocationOutage или availabilityNodeOutage задано значение . |
по желанию |
availabilityNotificationsEnabled | boolean | Уведомления о сбое местоположения и ноды включены ( true ) или отключены ( false ).
|
по желанию |
deploymentType | string | Тип развертывания местоположения:
Элемент может содержать эти значения
|
по желанию |
autoUpdateChromium | boolean | Автоматическое обновление Chromium включено ( true ) или отключено ( false ).
|
по желанию |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
{
"nodes": [
"string"
],
"availabilityLocationOutage": true,
"availabilityNodeOutage": true,
"locationNodeOutageDelayInMinutes": 1,
"availabilityNotificationsEnabled": true,
"deploymentType": "KUBERNETES",
"autoUpdateChromium": true
}
Ответ
Коды ответов
Код | Тип | Описание |
---|---|---|
200 | EntityIdDto | Успех |
Объекты тела ответа
Объект EntityIdDto
DTO для идентификатора объекта.
Элемент | Тип | Описание |
---|---|---|
entityId | string | Идентификатор объекта для передачи |
JSON-модель тела ответа
{
"entityId": "string"
}
Пример
В этом примере запрос создает новое частное синтетическое местоположение. Это место находится в Линце, Австрия . Он использует синтетическую ноду с идентификатором 93302281 .
Маркер API передается в заголовке авторизации .
Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде.
Curl
curl -X POST \
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281"
]
}
'
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations
Тело запроса
{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["93302281"]
}
Тело ответа
{
"entityId": "SYNTHETIC_LOCATION-8F419D1B53639A45"
}
Код ответа
200