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

Версия от 15:43, 20 октября 2022

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

Запрос создает application/jsonполезную нагрузку.

GET	Managed	`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

@@ Строка 3: / Строка 3: @@
 Запрос создает <code>application/json</code>полезную нагрузку.
 {| class="wikitable"
-| rowspan="3" |ПОЛУЧИТЬ
+| rowspan="2" |GET
-|Удалось
+|Managed
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations</nowiki></code>
 |-
-|SaaS
+|Среда АктивногоШлюза
-|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations</nowiki></code>
-|-
-|Окружающая среда ActiveGate
 |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations</nowiki></code>
 |}
 == Аутентификация ==
-Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение синтетических местоположений ( <code>syntheticLocations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
+Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение синтетических местоположений ( <code>syntheticLocations.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .
 == Параметры ==
@@ Строка 22: / Строка 19: @@
 !Тип
 !Описание
-!В
+!In
 !Необходимый
 |-
-|облачная платформа
+|cloudPlatform
-|нить
+|string
 |Отфильтровывает результирующий набор местоположений на те, которые размещены на определенной облачной платформе.
@@ Строка 36: / Строка 33: @@
 * <code>GOOGLE_CLOUD</code>
 * <code>OTHER</code>
-|запрос
+|query
 |по желанию
 |-
-|тип
+|type
-|нить
+|string
 |Отфильтровывает результирующий набор местоположений по определенному типу.
@@ Строка 47: / Строка 44: @@
 * <code>PUBLIC</code>
 * <code>PRIVATE</code>
-|запрос
+|query
 |по желанию
 |}
@@ Строка 60: / Строка 57: @@
 |-
 |200
-|Синтетические локации
+|SyntheticLocations
 |Успех
 |}
@@ Строка 66: / Строка 63: @@
 === Объекты тела ответа ===
-==== Объект _ <code>SyntheticLocations</code> ====
+==== Объект <code>SyntheticLocations</code> ====
 Список синтетических локаций.
 {| class="wikitable"
@@ Строка 73: / Строка 70: @@
 !Описание
 |-
-|локации
+|locations
-|Элемент коллекции местоположения []
+|LocationCollectionElement[]
 |Список синтетических локаций.
 |}
-==== Объект _ <code>LocationCollectionElement</code> ====
+==== Объект <code>LocationCollectionElement</code> ====
 Синтетическая локация.
 {| class="wikitable"
@@ Строка 85: / Строка 82: @@
 !Описание
 |-
-|имя
+|name
-|нить
+|string
 |Название локации.
 |-
-|идентификатор сущности
+|entityId
-|нить
+|string
-|Идентификатор объекта Dynatrace для местоположения.
+|Идентификатор объекта Ключ-АСТРОМ для местоположения.
 |-
-|тип
+|type
-|нить
+|string
 |Тип локации.
@@ Строка 103: / Строка 100: @@
 * <code>PUBLIC</code>
 |-
-|облачная платформа
+|cloudPlatform
-|нить
+|string
 |Облачный провайдер, у которого размещено местоположение.
@@ Строка 114: / Строка 111: @@
 * <code>AMAZON_EC2</code>
 * <code>AZURE</code>
-* <code>DYNATRACE_CLOUD</code>
+* <code>ASTROMKEY_CLOUD</code>
 * <code>GOOGLE_CLOUD</code>
 * <code>INTEROUTE</code>
@@ Строка 121: / Строка 118: @@
 |-
 |ips
-|строка []
+|string[]
 |Список IP-адресов, присвоенных местоположению.
 Применимо только к <code>PUBLIC</code>локациям.
 |-
-|сцена
+|stage
-|нить
+|string
 |Стадия релиза локации.
@@ Строка 137: / Строка 134: @@
 * <code>GA</code>
 |-
-|статус
+|status
-|нить
+|string
 |Статус локации.
@@ Строка 147: / Строка 144: @@
 * <code>HIDDEN</code>
 |-
-|идентификатор геолокации
+|geoLocationId
-|нить
+|string
-|Идентификатор местоположения Dynatrace GeoLocation.
+|Идентификатор местоположения Ключ-АСТРОМ GeoLocation.
 |}
@@ Строка 189: / Строка 186: @@
 Результат усекается до трех записей.
-==== Завиток ====
+==== Curl ====
   <code>curl -X GET \
-    <nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations</nowiki> \
+    <nowiki>https://mySampleEnv.live.ruscomtech.ru/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><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v2/synthetic/locations</nowiki></code>
 ==== Тело ответа ====