GET все локации*: различия между версиями
ENetrebin (обсуждение | вклад)  (Новая страница: «Список всех местоположений, общедоступных и частных, и их параметров, доступных для ваше...»)  | 
				ENetrebin (обсуждение | вклад)   | 
				||
| Строка 7: | Строка 7: | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>  | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>  | ||
|-  | |-  | ||
|Среда   | |Среда ActiveGate  | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>  | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations</nowiki></code>  | ||
|}  | |}  | ||
| Строка 88: | Строка 88: | ||
|entityId  | |entityId  | ||
|string  | |string  | ||
|Идентификатор объекта   | |Идентификатор объекта Dynatrace для местоположения.  | ||
|-  | |-  | ||
|type  | |type  | ||
| Строка 181: | Строка 181: | ||
==== Curl ====  | ==== Curl ====  | ||
  <code>curl -X GET \  |   <code>curl -X GET \  | ||
    <nowiki>https://mySampleEnv.live.  |     <nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations</nowiki> \  | ||
    -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>  |     -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'</code>  | ||
==== URL-адрес запроса ====  | ==== URL-адрес запроса ====  | ||
  <code><nowiki>https://mySampleEnv.live.  |   <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations</nowiki></code>  | ||
==== Тело ответа ====  | ==== Тело ответа ====  | ||
Текущая версия на 14:45, 13 февраля 2023
Список всех местоположений, общедоступных и частных, и их параметров, доступных для вашей среды.
Запрос создает в качестве полезной нагрузки application/json формат.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations
 | 
| Среда ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations
 | 
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость | 
|---|---|---|---|---|
| cloudPlatform | string | Отфильтровывает результирующий набор местоположений на те, которые размещены на определенной облачной платформе.
 Элемент может содержать эти значения 
  | 
query | по желанию | 
| type | string | Фильтрует результирующий набор местоположений по определенному типу.
 Элемент может содержать эти значения 
  | 
query | по желанию | 
Ответ
Коды ответов
| Код | Тип | Описание | 
|---|---|---|
| 200 | SyntheticLocations | Успех | 
Объекты тела ответа
Объект SyntheticLocations
Список синтетических локаций.
| Элемент | Тип | Описание | 
|---|---|---|
| locations | LocationCollectionElement[] | Список синтетических локаций. | 
Объект LocationCollectionElement
Синтетическая локация.
| Элемент | Тип | Описание | 
|---|---|---|
| name | string | Название локации. | 
| entityId | string | Идентификатор объекта Dynatrace для местоположения. | 
| type | string | Тип локации.
 Элемент может содержать эти значения 
  | 
| cloudPlatform | string | Облачный провайдер, у которого размещено местоположение.
 Применимо только к  Элемент может содержать эти значения 
  | 
| ips | string[] | Список IP-адресов, присвоенных местоположению.
 Применимо только к   | 
| stage | string | Стадия релиза локации.
 Элемент может содержать эти значения 
  | 
| status | string | Статус локации.
 Элемент может содержать эти значения 
  | 
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.dynatrace.com/api/v1/synthetic/locations \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
URL-адрес запроса
https://mySampleEnv.live.dynatrace.com/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