GET все локации: различия между версиями

Текущая версия от 14:50, 26 декабря 2024

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

Запрос создает в качестве полезной нагрузкиapplication/json формат.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение синтетических местоположений ( syntheticLocations.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимый
cloudPlatform	string	Отфильтровывает результирующий набор местоположений на те, которые размещены на определенной облачной платформе. Элемент может содержать эти значения `AWS` `AZURE` `ALIBABA` `GOOGLE_CLOUD` `OTHER`	query	по желанию
type	string	Отфильтровывает результирующий набор местоположений по определенному типу. Элемент может содержать эти значения `PUBLIC` `PRIVATE`	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	SyntheticLocations	Успех

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

Объект `SyntheticLocations`

Список синтетических локаций.

Элемент	Тип	Описание
locations	LocationCollectionElement[]	Список синтетических локаций.

Объект `LocationCollectionElement`

Синтетическая локация.

Элемент	Тип	Описание
name	string	Название локации.
entityId	string	Идентификатор объекта АппОптима для местоположения.
type	string	Тип локации. Элемент может содержать эти значения `CLUSTER` `PRIVATE` `PUBLIC`
cloudPlatform	string	Облачный провайдер, у которого размещено местоположение. Применимо только к `PUBLIC`локациям. Элемент может содержать эти значения `ALIBABA` `AMAZON_EC2` `AZURE` `ASTROMKEY_CLOUD` `GOOGLE_CLOUD` `INTEROUTE` `OTHER` `UNDEFINED`
ips	string[]	Список IP-адресов, присвоенных местоположению. Применимо только к `PUBLIC`локациям.
stage	string	Стадия релиза локации. Элемент может содержать эти значения `BETA` `COMING_SOON` `DELETED` `GA`
status	string	Статус локации. Элемент может содержать эти значения `DISABLED` `ENABLED` `HIDDEN`
geoLocationId	string	Идентификатор местоположения АппОптима GeoLocation.

JSON-модель тела ответа

<{
  "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"
    }
  ]
}

Пример

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

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

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

Curl

<curl -X GET \
  https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations

Тело ответа

<{
  "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"
    }
  ]
}

Код ответа

200

@@ Строка 4: / Строка 4: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations</nowiki></code>
 |-
@@ Строка 88: / Строка 88: @@
 |entityId
 |string
-|Идентификатор объекта Ключ-АСТРОМ для местоположения.
+|Идентификатор объекта АппОптима для местоположения.
 |-
 |type
@@ Строка 146: / Строка 146: @@
 |geoLocationId
 |string
-|Идентификатор местоположения Ключ-АСТРОМ GeoLocation.
+|Идентификатор местоположения АппОптима GeoLocation.
 |}
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "locations": [
       {
@@ Строка 177: / Строка 177: @@
       }
     ]
-  }</code>
+  }
 == Пример ==
@@ Строка 187: / Строка 187: @@
 ==== Curl ====
-  <code>curl -X GET \
+  <curl -X GET \
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations</nowiki> \
-    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
@@ Строка 195: / Строка 195: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "locations": [
       {
@@ Строка 241: / Строка 241: @@
       }
     ]
-  }</code>
+  }
 ==== Код ответа ====