ENetrebin: Новая страница: «Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтет...»

2022-10-24T14:52:25Z

Новая страница: «Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтет...»

Новая страница

Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтетического местоположения см. в разделе Создание частного искусственного местоположения .

Запрос создаёт и потребляет в качестве полезной нагрузки<code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |POST
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>
|}

== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью создания и чтения синтетических мониторов, местоположений и узлов ( <code>ExternalSyntheticIntegration</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметр ==
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|body
|SyntheticLocation
|Тело JSON запроса. Содержит параметры новой частной синтетической локации.
|body
|по желанию
|}

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

==== Объект <code>SyntheticLocation</code> ====
Конфигурация синтетической локации.

Параметры countryCode , regionCode , city являются необязательными, поскольку их можно получить на основе широты и долготы местоположения.

Фактический набор полей зависит от типа местоположения. Найдите список актуальных объектов в описании поля типа или см. Синтетические локации API v2 — модели JSON .
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|nodes
|string[]
|Список синтетических нод, принадлежащих локации.

Вы можете получить список доступных нод с помощью вызова GET all nodes .
|по желанию
|-
|availabilityLocationOutage
|boolean
|Предупреждение об отключении местоположения включено ( <code>true</code>) или отключено ( <code>false</code>).
|по желанию
|-
|availabilityNodeOutage
|boolean
|Оповещение об отключении ноды включено ( <code>true</code>) или отключено ( <code>false</code>).

Если включено, сбой ''любой'' ноды в локации вызывает оповещение.
|по желанию
|-
|locationNodeOutageDelayInMinutes
|integer
|Оповещение, если сбой местоположения или ноды длится дольше ''X'' минут.

Применимо только в том случае, если для параметра availabilityLocationOutage или availabilityNodeOutage задано значение .<code>true</code>
|по желанию
|-
|availabilityNotificationsEnabled
|boolean
|Уведомления о сбое местоположения и ноды включены ( <code>true</code>) или отключены ( <code>false</code>).
|по желанию
|-
|deploymentType
|string
|Тип развертывания местоположения:

* <code>STANDARD</code>: расположение развернуто в Windows или Linux.
* <code>KUBERNETES</code>: расположение развернуто в Kubernetes.

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

* <code>KUBERNETES</code>
* <code>STANDARD</code>
|по желанию
|-
|autoUpdateChromium
|boolean
|Автоматическое обновление Chromium включено ( <code>true</code>) или отключено ( <code>false</code>).
|по желанию
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"nodes": [
"string"
],
"availabilityLocationOutage": true,
"availabilityNodeOutage": true,
"locationNodeOutageDelayInMinutes": 1,
"availabilityNotificationsEnabled": true,
"deploymentType": "KUBERNETES",
"autoUpdateChromium": true
}</code>

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|EntityIdDto
|Успех
|}

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

==== Объект <code>EntityIdDto</code> ====
DTO для идентификатора объекта.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|entityId
|string
|Идентификатор объекта для передачи
|}

=== JSON-модель тела ответа ===
<code>{
"entityId": "string"
}</code>

== Пример ==
В этом примере запрос создает новое частное синтетическое местоположение. Это место находится в Линце, Австрия . Он использует синтетическую ноду с идентификатором 93302281 .

Маркер API передается в заголовке авторизации .

Вы можете скачать или скопировать образец тела запроса, чтобы попробовать его самостоятельно. Обязательно замените список узлов узлами, доступными в вашей среде.

==== Curl ====
<code>curl -X POST \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations</nowiki> \
-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"
]
}
'</code>

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations</nowiki></code>

==== Тело запроса ====
<code>{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["93302281"]
}</code>

==== Тело ответа ====
<code>{
"entityId": "SYNTHETIC_LOCATION-8F419D1B53639A45"
}</code>

==== Код ответа ====
200

POST локация* - История изменений

ENetrebin: Новая страница: «Создает новую частную синтетическую локацию. Дополнительные сведения о создании синтет...»