GET все приложения

Материал из Dynatrace

Получает список всех приложений в вашей среде Dynatrace вместе с их параметрами.

Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.

Вы можете дополнительно ограничить вывод с помощью нумерации страниц:

  1. Укажите количество результатов на странице в параметре запроса pageSize .
  2. Затем используйте курсор из заголовка ответа Next-Page-Key в параметре запроса nextPageKey для получения последующих страниц.

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v1/entity/applications
Среда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/applications

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

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

Параметры

Параметр Тип Описание In Необходимость
startTimestamp integer Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).

Если не задано, используется отставание на 72 часа.

query по желанию
endTimestamp integer Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC).

Если не задано, используется текущая метка времени.

Срок не должен превышать 3 дней.

query по желанию
relativeTime string Относительный период времени, начиная с настоящего времени.

Элемент может содержать эти значения

  • min
  • 5mins
  • 10mins
  • 15mins
  • 30mins
  • hour
  • 2hours
  • 6hours
  • day
  • 3days
 query по желанию
tag string [] Фильтрует результирующий набор приложений по указанному тегу. Вы можете указать несколько тегов в следующем формате: tag=tag1&tag=tag2. Приложение должно соответствовать всем указанным тегам.

В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: tag=[context]key:value. Для пользовательских тегов "ключ-значение" не указывайте контекст: tag=key:value.

query по желанию
entity string [] Фильтры приводят только к указанным приложениям.

Чтобы указать несколько приложений, используйте следующий формат: entity=ID1&entity=ID2.

query по желанию
managementZone integer Возвращает только те приложения, которые входят в указанную зону управления. query по желанию
includeDetails boolean Включает ( true) или исключает ( false) детали, которые запрашиваются у связанных объектов.

Исключение сведений может ускорить запросы.

Если не установлено, то trueиспользуется.

query по желанию
pageSize integer Количество заявок на страницу результатов.

Если не задано, нумерация страниц не используется, а результат содержит все приложения, соответствующие заданным критериям фильтрации.

query по желанию
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в заголовке Next-Page-Key предыдущего ответа.

Если вы используете нумерацию страниц, первая страница всегда возвращается без этого курсора.

Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы.

query по желанию

Заголовки ответа

Заголовок Тип Описание
Total-Count integer Предполагаемое количество результатов.
Next-Page-Key string Курсор для следующей страницы результатов. Без него вы снова получите первую страницу.
Page-Size string Максимальное количество результатов на странице.

Ответ

Коды ответов

Код Тип Описание
200 Application[] Успех
400 ErrorEnvelope Не удалось. Ввод недействителен.

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

Объект ResponseBody

Объект не предоставляет никаких параметров.

Объект Application

Элемент Тип Описание
entityId string Идентификатор объекта Dynatrace требуемого объекта.
displayName string Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
customizedName string Пользовательское имя объекта
discoveredName string Обнаруженное имя объекта
firstSeenTimestamp integer Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp integer Отметка времени последнего обнаружения объекта в миллисекундах UTC.
tags TagInfo[] Список тегов сущностей.
fromRelationships объект Список исходящих вызовов из приложения.
toRelationships объект Список входящих вызовов в приложение.
applicationMatchTarget string -

Элемент может содержать эти значения

  • DOMAIN
  • URL
managementZones EntityShortRepresentation[] Зоны управления, частью которых является объект.
ruleAppliedPattern string -
ruleAppliedMatchType string -

Элемент может содержать эти значения

  • ALL_URLS_AND_DOMAINS
  • CONTAINS
  • ENDS
  • EQUALS
  • MATCHES
  • STARTS
applicationType string -

Элемент может содержать эти значения

  • AGENTLESS_MONITORING
  • AMP
  • AUTO_INJECTED
  • DEFAULT
  • SAAS_VENDOR

Объект TagInfo

Тег сущности Dynatrace.

Элемент Тип Описание
context string Происхождение тега, например AWS или Cloud Foundry.

Пользовательские теги используют это CONTEXTLESSзначение.

Элемент может содержать эти значения

  • AWS
  • AWS_GENERIC
  • AZURE
  • CLOUD_FOUNDRY
  • CONTEXTLESS
  • ENVIRONMENT
  • GOOGLE_CLOUD
  • KUBERNETES
key string Ключ тега.

Пользовательские теги имеют значение тега здесь.

value string Значение тега.

Не применимо к пользовательским тегам.

Объект EntityShortRepresentation

Краткое представление объекта Dynatrace.

Элемент Тип Описание
id string Идентификатор объекта Dynatrace.
name string Имя объекта Dynatrace.
description string Краткое описание сущности Dynatrace.

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

[
  {
    "entityId": "string",
    "displayName": "string",
    "customizedName": "string",
    "discoveredName": "string",
    "firstSeenTimestamp": 1,
    "lastSeenTimestamp": 1,
    "tags": [
      {
        "context": "AWS",
        "key": "string",
        "value": "string"
      }
    ],
    "fromRelationships": {
      "calls": [
        "string"
      ]
    },
    "toRelationships": {
      "monitors": [
        "string"
      ]
    },
    "applicationMatchTarget": "DOMAIN",
    "managementZones": [
      {
        "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
        "name": "Dynatrace entity",
        "description": "Dynatrace entity for the REST API example"
      }
    ],
    "ruleAppliedPattern": "string",
    "ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS",
    "applicationType": "AGENTLESS_MONITORING"
  }
]

Пример

В этом примере запрос запрашивает список всех приложений в среде.

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

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

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/entity/applications/ \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.dynatrace.com/api/v1/entity/applications

Тело ответа

[
  {
    "entityId": "APPLICATION-EA7C4B59F27D43EB",
    "displayName": "RUM Default Application",
    "customizedName": "RUM Default Application",
    "discoveredName": "RUM Default Application",
    "firstSeenTimestamp": 1422282024216,
    "lastSeenTimestamp": 1538579528065,
    "tags": [
      {
        "context": "CONTEXTLESS",
        "key": "Mytag"
      },
      {
        "context": "CONTEXTLESS",
        "key": "Test"
      }
    ],
    "fromRelationships": {
      "calls": [
        "SERVICE-FFE4B7A6D72F2CAC"
      ]
    },
    "toRelationships": {},
    "applicationType": "DEFAULT",
    "ruleAppliedPattern": "http",
    "managementZones": [
      {
        "id": "-6239538939987181652",
        "name": "allTypes"
      },
      {
        "id": "-2519468841583898843",
        "name": "app name exists"
      },
      {
        "id": "4485554873951847460",
        "name": "Applications except easyTravel"
      }
    ]
  },
  {
    "entityId": "APPLICATION-BBFA55551D507E2B",
    "displayName": "easyTravel Ionic Web",
    "discoveredName": "easyTravel Ionic Web",
    "firstSeenTimestamp": 1528695861873,
    "lastSeenTimestamp": 1538572321269,
    "tags": [],
    "fromRelationships": {
      "calls": [
        "SERVICE-ED0B103392AC86BF"
      ]
    },
    "toRelationships": {},
    "applicationType": "RUMONLY",
    "managementZones": [
      {
        "id": "-6239538939987181652",
        "name": "allTypes"
      },
      {
        "id": "-4085081632192243904",
        "name": "easyTravel"
      }
    ]
  },
  {
    "entityId": "MOBILE_APPLICATION-752C288D59734C79",
    "displayName": "easyTravel Demo",
    "customizedName": "easyTravel Demo",
    "discoveredName": "752c288d-5973-4c79-b7d1-3a49d4d42ea0",
    "firstSeenTimestamp": 1469613941393,
    "lastSeenTimestamp": 1538654940201,
    "tags": [
      {
        "context": "CONTEXTLESS",
        "key": "portal"
      },
      {
        "context": "CONTEXTLESS",
        "key": "easyTravel"
      }
    ],
    "fromRelationships": {
      "calls": [
        "SERVICE-ED0B103392AC86BF"
      ]
    },
    "toRelationships": {},
    "mobileOsFamily": [
      "ANDROID",
      "IOS",
      "WINDOWS"
    ],
    "managementZones": [
      {
        "id": "-4085081632192243904",
        "name": "easyTravel"
      }
    ]
  }
]

Код ответа

200

Источник — https://doc.expert-apm.kz/index.php?title=GET_все_приложения&oldid=2955