ENetrebin: Новая страница: «Список всех местоположений, общедоступных и частных, и их параметров, доступных для ваше...»

2022-10-24T14:27:58Z

Новая страница: «Список всех местоположений, общедоступных и частных, и их параметров, доступных для ваше...»

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

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

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|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>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|cloudPlatform
|string
|Отфильтровывает результирующий набор местоположений на те, которые размещены на определенной облачной платформе.

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

* <code>AWS</code>
* <code>AZURE</code>
* <code>ALIBABA</code>
* <code>GOOGLE_CLOUD</code>
* <code>OTHER</code>
|query
|по желанию
|-
|type
|string
|Фильтрует результирующий набор местоположений по определенному типу.

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

* <code>PUBLIC</code>
* <code>PRIVATE</code>
|query
|по желанию
|}

== Ответ ==

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

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

==== Объект <code>SyntheticLocations</code> ====
Список синтетических локаций.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|locations
|LocationCollectionElement[]
|Список синтетических локаций.
|}

==== Объект <code>LocationCollectionElement</code> ====
Синтетическая локация.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|name
|string
|Название локации.
|-
|entityId
|string
|Идентификатор объекта Ключ-АСТРОМ для местоположения.
|-
|type
|string
|Тип локации.

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

* <code>CLUSTER</code>
* <code>PRIVATE</code>
* <code>PUBLIC</code>
|-
|cloudPlatform
|string
|Облачный провайдер, у которого размещено местоположение.

Применимо только к <code>PUBLIC</code>локациям.

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

* <code>ALIBABA</code>
* <code>AMAZON_EC2</code>
* <code>AZURE</code>
* <code>GOOGLE_CLOUD</code>
* <code>INTEROUTE</code>
* <code>OTHER</code>
* <code>UNDEFINED</code>
|-
|ips
|string[]
|Список IP-адресов, присвоенных местоположению.

Применимо только к <code>PUBLIC</code>локациям.
|-
|stage
|string
|Стадия релиза локации.

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

* <code>BETA</code>
* <code>COMING_SOON</code>
* <code>DELETED</code>
* <code>GA</code>
|-
|status
|string
|Статус локации.

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

* <code>DISABLED</code>
* <code>ENABLED</code>
* <code>HIDDEN</code>
|}

=== JSON-модель тела ответа ===
<code>{
"locations": [
{
"name": "Gdansk",
"entityId": "GEOLOCATION-B8D793BCA914E0AF",
"type": "PUBLIC",
"cloudPlatform": "AMAZON_EC2",
"ips": [
"134.189.153.97",
"134.189.153.98"
],
"stage": "GA",
"status": "ENABLED",
"capabilities": [
"BROWSER",
"HTTP"
]
},
{
"name": "My private location",
"entityId": "SYNTHETIC_LOCATION-53F47ECB33907667",
"type": "PRIVATE",
"status": "ENABLED"
}
]
}</code>

== Пример ==
В этом примере в запросе перечислены все искусственные расположения, доступные для среды mySampleEnv .

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

Результат усекается до трех записей.

==== Curl ====
<code>curl -X GET \
<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations</nowiki> \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>

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

==== Тело ответа ====
<code>{
"locations": [
{
"name": "Amazon US East (N. Virginia)",
"entityId": "GEOLOCATION-95196F3C9A4F4215",
"type": "PUBLIC",
"cloudPlatform": "AMAZON_EC2",
"ips": [
"134.189.153.97",
"134.189.153.98",
"134.189.153.99"
]
},
{
"name": "AWS Europe (London)",
"entityId": "GEOLOCATION-A9022AAFA0763F56",
"type": "PUBLIC",
"cloudPlatform": "AMAZON_EC2",
"ips": [
"243.22.221.174",
"104.179.71.29"
]
},
{
"name": "Gdansk HTTP",
"entityId": "SYNTHETIC_LOCATION-9C75B59442498323",
"type": "PRIVATE"
}
]
}</code>

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

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

ENetrebin: Новая страница: «Список всех местоположений, общедоступных и частных, и их параметров, доступных для ваше...»