GET приложение

Материал из Документация Ключ-АСТРОМ

Получает параметры указанного приложения.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимый
meIdentifier string Идентификатор объекта Ключ-АСТРОМ требуемого приложения. path требуется

Ответ

Коды ответов

Код Тип Описание
200 Application Успех

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

Объект Application

Элемент Тип Описание
entityId string Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
displayName string Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
customizedName string Пользовательское имя объекта
discoveredName string Обнаруженное имя объекта
firstSeenTimestamp integer Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp integer Отметка времени последнего обнаружения объекта в миллисекундах UTC.
tags TagInfo[] Список тегов сущностей.
fromRelationships object Список исходящих вызовов из приложения.
toRelationships object Список входящих звонков в приложение.
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

Тег сущности Ключ-АСТРОМ.

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

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

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

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

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

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

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

Объект EntityShortRepresentation

Краткое представление объекта Ключ-АСТРОМ.

Элемент Тип Описание
id string Идентификатор объекта Ключ-АСТРОМ.
name string Имя объекта Ключ-АСТРОМ.
description string Краткое описание сущности Ключ-АСТРОМ.

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": "Astromkey entity",
      "description": "Astromkey entity for the REST API example"
    }
  ],
  "ruleAppliedPattern": "string",
  "ruleAppliedMatchType": "ALL_URLS_AND_DOMAINS",
  "applicationType": "AGENTLESS_MONITORING"
}

Пример

В этом примере запрос запрашивает свойства демо - приложения easyTravel с идентификатором MOBILE_APPLICATION-752C288D59734C79 .

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

Curl

curl --request GET \
  --url https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79 \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/applications/MOBILE_APPLICATION-752C288D59734C79

Тело ответа

{
  "entityId": "MOBILE_APPLICATION-752C288D59734C79",
  "displayName": "easyTravel Demo",
  "customizedName": "easyTravel Demo",
  "discoveredName": "752c288d-5973-4c79-b7d1-3a49d4d42ea0",
  "firstSeenTimestamp": 1469613941393,
  "lastSeenTimestamp": 1538656560201,
  "tags": [
    {
      "context": "CONTEXTLESS",
      "key": "portal"
    },
    {
      "context": "CONTEXTLESS",
      "key": "easyTravel"
    }
  ],
  "fromRelationships": {
    "calls": [
      "SERVICE-ED0B103392AC86BF"
    ]
  },
  "toRelationships": {},
  "mobileOsFamily": [
    "ANDROID",
    "IOS",
    "WINDOWS"
  ],
  "managementZones": [
    {
      "id": "-6239538939987181652",
      "name": "allTypes"
    },
    {
      "id": "6518151499932123858",
      "name": "mobile app name exists"
    },
    {
      "id": "-4085081632192243904",
      "name": "easyTravel"
    }
  ]
}

Код ответа

200