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

Текущая версия от 17:05, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Синтетика v1 / Синтетические локации / GET все локации*

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

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

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

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

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

Параметры

Параметр	Тип	Описание	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` `GOOGLE_CLOUD` `INTEROUTE` `OTHER` `UNDEFINED`
ips	string[]	Список IP-адресов, присвоенных местоположению. Применимо только к `PUBLIC`локациям.
stage	string	Стадия релиза локации. Элемент может содержать эти значения `BETA` `COMING_SOON` `DELETED` `GA`
status	string	Статус локации. Элемент может содержать эти значения `DISABLED` `ENABLED` `HIDDEN`

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

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

Пример

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

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

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

Curl

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

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

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

Тело ответа

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

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=GET%20%D1%81%D1%85%D0%B5%D0%BC%D0%B0-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D0%BA%D0%B0%20v1,-%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BC%D0%BE%D0%BD%D0%B8%D1%82%D0%BE%D1%80%D1%8B Синтетика v1] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=JSON%20%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8-,%D0%A1%D0%B8%D0%BD%D1%82%D0%B5%D1%82%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BB%D0%BE%D0%BA%D0%B0%D1%86%D0%B8%D0%B8 Синтетические локации] / GET все локации*'''''
 Список всех местоположений, общедоступных и частных, и их параметров, доступных для вашей среды.
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>
 |-
@@ Строка 88: / Строка 90: @@
 |entityId
 |string
-|Идентификатор объекта Ключ-АСТРОМ для местоположения.
+|Идентификатор объекта АппОптима для местоположения.
 |-
 |type
@@ Строка 145: / Строка 147: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "locations": [
       {
@@ Строка 170: / Строка 172: @@
       }
     ]
-  }</code>
+  }
 == Пример ==
@@ Строка 180: / Строка 182: @@
 ==== Curl ====
-  <code>curl -X GET \
+  <curl -X GET \
     <nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/locations</nowiki> \
-    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
+    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
 ==== URL-адрес запроса ====
@@ Строка 188: / Строка 190: @@
 ==== Тело ответа ====
-  <code>{
+  <{
     "locations": [
       {
@@ Строка 217: / Строка 219: @@
       }
     ]
-  }</code>
+  }
 ==== Код ответа ====