ENetrebin: Новая страница: «Обновляет существующее частное синтетическое местоположение. Запрос потребляет в каче...»

2022-10-24T15:02:47Z

Новая страница: «Обновляет существующее частное синтетическое местоположение. Запрос потребляет в каче...»

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

Обновляет существующее частное синтетическое местоположение.

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

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

== Параметры ==
Чтобы найти все варианты моделей, зависящие от типа модели, см. раздел модели JSON .
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|locationId
|string
|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
|path
|требуется
|-
|body
|SyntheticLocationUpdate
|Тело JSON запроса. Содержит обновленные параметры частной синтетической локации или статус локации.
|body
|по желанию
|}

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

==== Объект <code>SyntheticLocationUpdate</code> ====
Обновление синтетической локации. Фактический объект зависит от типа местоположения.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code>-> SyntheticPublicLocationUpdate
* <code>PRIVATE</code>-> PrivateSyntheticLocationUpdate

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

* <code>PRIVATE</code>
* <code>PUBLIC</code>
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"type": "PRIVATE",
"name": "Linz Location",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281"
],
"status": "ENABLED"
}</code>

== Ответ ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимый
|-
|locationId
|string
|Идентификатор объекта Ключ-АСТРОМ синтетического местоположения, которое необходимо обновить.
|path
|требуется
|-
|body
|SyntheticLocationUpdate
|Тело JSON запроса. Содержит обновленные параметры частной синтетической локации или статус локации.
|body
|по желанию
|}

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

==== Объект <code>SyntheticLocationUpdate</code> ====
Обновление синтетической локации. Фактический объект зависит от типа местоположения.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Определяет фактический набор полей в зависимости от значения. См. один из следующих объектов:

* <code>PUBLIC</code>-> SyntheticPublicLocationUpdate
* <code>PRIVATE</code>-> PrivateSyntheticLocationUpdate

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

* <code>PRIVATE</code>
* <code>PUBLIC</code>
|требуется
|}

=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<code>{
"type": "PRIVATE",
"name": "Linz Location",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281"
],
"status": "ENABLED"
}</code>

== Пример ==
В этом примере запрос обновляет приватное синтетическое расположение из примера POST-запроса . Он меняет название местоположения на Linz и добавляет узел Synthetic с идентификатором 353074222 .

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

Код ответа 204 означает, что обновление прошло успешно.

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

==== Curl ====
<code>curl -X PUT \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"type": "PRIVATE",
"name": "Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281",
"353074222"
]
}
'</code>

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

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

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

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

ENetrebin: Новая страница: «Обновляет существующее частное синтетическое местоположение. Запрос потребляет в каче...»