Просмотр кода страницы Получение всех частных синтетических локаций (GET все локации)

Этот вызов API перечисляет все локации, общедоступные и частные, и их параметры, доступные для вашей среды. Запрос создает полезную нагрузку <code>application/json</code>.
==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение одной из областей API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
==Конечная точка==
<code>/api/cluster/v2/synthetic/locations</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|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>DYNATRACE_CLOUD</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>
|-
|geoLocationId
|string
|Идентификатор местоположения.
|}
===JSON-модель тела ответа===
 <code>{
   "locations": [
     {
       "name": "Gdansk",
       "entityId": "SYNTHETIC_LOCATION-53F47ECB33907667",
       "geoLocationId": "GEOLOCATION-95196F3C9A4F4215",
       "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",
       "geoLocationId": "GEOLOCATION-95196F3C9A4F4215",
       "type": "PRIVATE",
       "status": "ENABLED"
     }
   ]
 }</code>
==Пример==
В этом примере в запросе перечислены все искусственные расположения, доступные для среды <code>mySampleEnv</code>. 

Токен API передается в заголовке '''Authorization'''. 

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

====Curl====
<code>curl -X GET \
<nowiki> </nowiki> <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations</nowiki> \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations</nowiki></code>
====Тело ответа====
 <code>{
   "locations": [
     {
       "name": "Amazon US East (N. Virginia)",
       "entityId": "SYNTHETIC_LOCATION-0000000000000004",
       "type": "PUBLIC",
       "cloudPlatform": "AMAZON_EC2",
       "ips": [
         "79.50.224.74",
         "96.124.117.100"
       ],
       "stage": "GA",
       "status": "ENABLED",
       "capabilities": [
         "BROWSER"
       ],
       "geoLocationId": "GEOLOCATION-95196F3C9A4F4215"
     },
     {
       "name": "Gdańsk",
       "entityId": "SYNTHETIC_LOCATION-0000000000000064",
       "type": "PUBLIC",
       "cloudPlatform": "OTHER",
       "ips": [
         "120.157.221.247",
         "172.158.6.93",
         "197.136.70.30",
         "227.53.205.237",
         "131.123.197.12"
       ],
       "stage": "GA",
       "status": "ENABLED",
       "capabilities": [
         "BROWSER",
         "HTTP"
       ],
       "geoLocationId": "GEOLOCATION-0A41430434C388A9"
     },
     {
       "name": "Linz HTTP",
       "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
       "type": "PRIVATE",
       "status": "ENABLED",
       "geoLocationId": "GEOLOCATION-427705B3488A4C45"
     }
   ]
 }</code>
====Код ответа====
<code>200</code>