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

Материал из Документация Ключ-АСТРОМ
(Новая страница: «Этот вызов API перечисляет все локации, общедоступные и частные, и их параметры, доступные...»)
 
 
(не показаны 2 промежуточные версии 1 участника)
Строка 96: Строка 96:
* <code>AMAZON_EC2</code>
* <code>AMAZON_EC2</code>
* <code>AZURE</code>
* <code>AZURE</code>
* <code>DYNATRACE_CLOUD</code>
* <code>GOOGLE_CLOUD</code>
* <code>GOOGLE_CLOUD</code>
* <code>INTEROUTE</code>
* <code>INTEROUTE</code>
Строка 165: Строка 164:
В этом примере в запросе перечислены все искусственные расположения, доступные для среды <code>mySampleEnv</code>.  
В этом примере в запросе перечислены все искусственные расположения, доступные для среды <code>mySampleEnv</code>.  


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


Результат усекается до трех записей.
Результат усекается до трех записей.
Строка 171: Строка 170:
====Curl====
====Curl====
<code>curl -X GET \
<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>
<nowiki> </nowiki> <nowiki>https://mySampleEnv.ru/api/v2/synthetic/locations</nowiki> \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>
====URL-адрес запроса====
====URL-адрес запроса====
<code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations</nowiki></code>
<code><nowiki>https://mySampleEnv.ru/api/v2/synthetic/locations</nowiki></code>
====Тело ответа====
====Тело ответа====
  <code>{
  <code>{
Строка 214: Строка 213:
     },
     },
     {
     {
       "name": "Linz HTTP",
       "name": "Omsk HTTP",
       "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
       "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
       "type": "PRIVATE",
       "type": "PRIVATE",

Текущая версия на 22:09, 5 сентября 2023

Этот вызов API перечисляет все локации, общедоступные и частные, и их параметры, доступные для вашей среды. Запрос создает полезную нагрузку application/json.

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

Для выполнения этого запроса вам необходимо разрешение одной из областей API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/cluster/v2/synthetic/locations

Параметры

Параметр Тип Описание В Обязательно
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
geoLocationId string Идентификатор местоположения.

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 передается в заголовке Authorization.

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

Curl

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

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

https://mySampleEnv.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": "Omsk HTTP",
      "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
      "type": "PRIVATE",
      "status": "ENABLED",
      "geoLocationId": "GEOLOCATION-427705B3488A4C45"
    }
  ]
}

Код ответа

200

Источник — https://doc.ruscomtech.ru/index.php?title=Получение_всех_частных_синтетических_локаций_(GET_все_локации)&oldid=3094