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

Материал из Dynatrace
(Новая страница: «Получает список всех процессов в вашей среде Dynatrace вместе с их параметрами и взаимосвязя...»)
 
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
Получает список всех процессов в вашей среде Dynatrace вместе с их параметрами и взаимосвязями.
Получает список всех процессов в вашей среде Ключ-АСТРОМ вместе с их параметрами и взаимосвязями.


Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Строка 10: Строка 10:
Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| rowspan="2" |GET
|Удалось
|Удалось
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes</nowiki></code>
|-
|-
|SaaS
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v1/entity/infrastructure/processes</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/infrastructure/processes</nowiki></code>
|}
|}


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( <code>DataExport</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Срок ограничен максимальным периодом в 3 дня .
Срок ограничен максимальным периодом в 3 дня .
{| class="wikitable"
{| class="wikitable"
!Параметр
|'''Параметр'''
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|startTimestamp
|startTimestamp
|целое число
|integer
|Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).
|Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).


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


Строка 48: Строка 45:


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


Строка 67: Строка 64:
* <code>day</code>
* <code>day</code>
* <code>3days</code>
* <code>3days</code>
|запрос
|query
|по желанию
|по желанию
|-
|-
|ярлык
|tag
|строка []
|string []
|Фильтрует результирующий набор процессов по указанному тегу. Вы можете указать несколько тегов в следующем формате: <code>tag=tag1&tag=tag2</code>. Процесс должен соответствовать всем указанным тегам.
|Фильтрует результирующий набор процессов по указанному тегу. Вы можете указать несколько тегов в следующем формате: <code>tag=tag1&tag=tag2</code>. Процесс должен соответствовать всем указанным тегам.


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


Чтобы указать несколько процессов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
Чтобы указать несколько процессов, используйте следующий формат: <code>entity=ID1&entity=ID2</code>.
|запрос
|query
|по желанию
|по желанию
|-
|-
|hostTag
|hostTag
|строка []
|string []
|Фильтрует процессы по узлу, на котором они запущены.
|Фильтрует процессы по узлу, на котором они запущены.


Укажите теги интересующего вас хоста.
Укажите теги интересующего вас хоста.
|запрос
|query
|по желанию
|по желанию
|-
|-
|хозяин
|host
|строка []
|string []
|Фильтрует процессы по узлу, на котором они запущены.
|Фильтрует процессы по узлу, на котором они запущены.


Укажите Dynatrace ID интересующего вас хоста.
Укажите Ключ-АСТРОМ ID интересующего вас хоста.


Для указания нескольких хостов используйте следующий формат: <code>host=hostID1&host=hostID2</code>.
Для указания нескольких хостов используйте следующий формат: <code>host=hostID1&host=hostID2</code>.


Применяется логика ИЛИ .
Применяется логика ИЛИ .
|запрос
|query
|по желанию
|по желанию
|-
|-
|фактическое состояние мониторинга
|actualMonitoringState
|нить
|string
|Фильтрует процессы по фактическому состоянию мониторинга процесса.
|Фильтрует процессы по фактическому состоянию мониторинга процесса.


Строка 114: Строка 111:
* <code>OFF</code>
* <code>OFF</code>
* <code>ON</code>
* <code>ON</code>
|запрос
|query
|по желанию
|по желанию
|-
|-
|ожидаемое состояние мониторинга
|expectedMonitoringState
|нить
|string
|Фильтрует процессы по ожидаемому состоянию мониторинга процесса.
|Фильтрует процессы по ожидаемому состоянию мониторинга процесса.


Строка 125: Строка 122:
* <code>OFF</code>
* <code>OFF</code>
* <code>ON</code>
* <code>ON</code>
|запрос
|query
|по желанию
|по желанию
|-
|-
|Зона управления
|managementZone
|целое число
|integer
|Возвратите только процессы, которые являются частью указанной зоны управления.
|Возвратите только процессы, которые являются частью указанной зоны управления.
|запрос
|query
|по желанию
|по желанию
|-
|-
|включитьДетали
|includeDetails
|логический
|boolean
|Включает ( <code>true</code>) или исключает ( <code>false</code>) детали, которые запрашиваются у связанных объектов.
|Включает ( <code>true</code>) или исключает ( <code>false</code>) детали, которые запрашиваются у связанных объектов.


Строка 141: Строка 138:


Если не установлено, то <code>true</code>используется.
Если не установлено, то <code>true</code>используется.
|запрос
|query
|по желанию
|по желанию
|-
|-
|размер страницы
|pageSize
|целое число
|integer
|Количество процессов на странице результатов.
|Количество процессов на странице результатов.


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


Строка 159: Строка 156:


Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы.
Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы.
|запрос
|query
|по желанию
|по желанию
|}
|}
Строка 172: Строка 169:
|-
|-
|200
|200
|Экземпляр группы процессов []
|ProcessGroupInstance[]
|Успех
|Успех
|-
|-
Строка 182: Строка 179:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>ResponseBody</code> ====
==== Объект <code>ResponseBody</code> ====
Объект не предоставляет никаких параметров.
Объект не предоставляет никаких параметров.


==== Объект _ <code>ProcessGroupInstance</code> ====
==== Объект <code>ProcessGroupInstance</code> ====
Параметры процесса.
Параметры процесса.
{| class="wikitable"
{| class="wikitable"
Строка 192: Строка 189:
!Описание
!Описание
|-
|-
|идентификатор объекта
|entityId
|нить
|string
|Идентификатор объекта Dynatrace требуемого объекта.
|Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
|-
|-
|показать имя
|displayName
|нить
|string
|Имя объекта Dynatrace, отображаемое в пользовательском интерфейсе.
|Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
|-
|-
|индивидуальное имя
|customizedName
|нить
|string
|Пользовательское имя объекта
|Пользовательское имя объекта
|-
|-
|обнаружил имя
|discoveredName
|нить
|string
|Обнаруженное имя объекта
|Обнаруженное имя объекта
|-
|-
|firstSeenTimestamp
|firstSeenTimestamp
|целое число
|integer
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|Отметка времени первого обнаружения объекта в миллисекундах UTC.
|-
|-
|lastSeenTimestamp
|lastSeenTimestamp
|целое число
|integer
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|Отметка времени последнего обнаружения объекта в миллисекундах UTC.
|-
|-
|теги
|tags
|Информация о теге []
|TagInfo[]
|Список тегов сущностей.
|Список тегов сущностей.
|-
|-
|отОтношения
|fromRelationships
|объект
|объект
| -
| -
|-
|-
|кОтношения
|toRelationships
|объект
|объект
| -
| -
|-
|-
|метаданные
|metadata
|объект
|объект
| -
| -
|-
|-
|управлениеЗоны
|softwareTechnologies
|Краткое представление объекта []
|TechnologyInfo[]
|Зоны управления, частью которых является объект.
|-
|модули
|строка []
| -
| -
|-
|-
|MonitoringState
|azureSiteName
|Состояние мониторинга
|string
|Определяет текущее состояние мониторинга объекта.
|-
|azureHostName
|нить
| -
| -
|-
|-
|azureSiteName
|versionedModules
|нить
|ProcessGroupInstanceModule[]
| -
| -
|-
|-
|listenPorts
|managementZones
|целое []
|EntityShortRepresentation[]
| -
|Зоны управления, частью которых является объект.
|-
|-
|версииedModules
|modules
|Модуль экземпляра группы процессов []
|string []
| -
| -
|-
|-
|агентВерсии
|agentVersions
|Версия агента []
|AgentVersion[]
|Версии OneAgents, которые в настоящее время работают на объекте.
|Версии ЕдиныхАгентов, которые в настоящее время работают на объекте.
|-
|-
|программное обеспечениеТехнологии
|listenPorts
|Информация о технологии []
|integer []
| -
| -
|-
|-
|битность
|bitness
|нить
|string
| -
| -
Элемент может содержать эти значения
Элемент может содержать эти значения
Строка 275: Строка 264:
* <code>32bit</code>
* <code>32bit</code>
* <code>64bit</code>
* <code>64bit</code>
|-
|azureHostName
|string
| -
|-
|monitoringState
|MonitoringState
|Определяет текущее состояние мониторинга объекта.
|}
|}


==== Объект _ <code>TagInfo</code> ====
==== Объект <code>TagInfo</code> ====
Тег сущности Dynatrace.
Тег сущности Ключ-АСТРОМ.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 284: Строка 281:
!Описание
!Описание
|-
|-
|контекст
|context
|нить
|string
|Происхождение тега, например AWS или Cloud Foundry.
|Происхождение тега, например AWS или Cloud Foundry.


Строка 301: Строка 298:
* <code>KUBERNETES</code>
* <code>KUBERNETES</code>
|-
|-
|ключ
|key
|нить
|string
|Ключ тега.
|Ключ тега.


Пользовательские теги имеют значение тега здесь.
Пользовательские теги имеют здесь значение тега.
|-
|-
|ценность
|value
|нить
|string
|Значение тега.
|Значение тега.


Строка 314: Строка 311:
|}
|}


==== Объект _ <code>EntityShortRepresentation</code> ====
==== Объект <code>TechnologyInfo</code> ====
Краткое представление объекта Dynatrace.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 321: Строка 317:
!Описание
!Описание
|-
|-
|я бы
|type
|нить
|string
|Идентификатор объекта Dynatrace.
| -
|-
|-
|имя
|edition
|нить
|string
|Имя объекта Dynatrace.
| -
|-
|-
|описание
|version
|нить
|string
|Краткое описание сущности Dynatrace.
| -
|}
|}


==== Объект _ <code>MonitoringState</code> ====
==== Объект <code>ProcessGroupInstanceModule</code> ====
Определяет текущее состояние мониторинга объекта.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 341: Строка 336:
!Описание
!Описание
|-
|-
|фактическое состояние мониторинга
|name
|нить
|string
|Текущее фактическое состояние мониторинга объекта.
| -
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|-
|ожидаемое состояние мониторинга
|version
|нить
|string
|Состояние мониторинга, ожидаемое от конфигурации
| -
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|перезапускОбязательный
|логический
|Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг
|}
|}


==== Объект _ <code>ProcessGroupInstanceModule</code> ====
==== Объект <code>EntityShortRepresentation</code> ====
Краткое представление объекта Ключ-АСТРОМ.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 370: Строка 352:
!Описание
!Описание
|-
|-
|имя
|id
|нить
|string
| -
|Идентификатор объекта Ключ-АСТРОМ.
|-
|name
|string
|Имя объекта Ключ-АСТРОМ.
|-
|-
|версия
|description
|нить
|string
| -
|Краткое описание сущности Ключ-АСТРОМ.
|}
|}


==== Объект _ <code>AgentVersion</code> ====
==== Объект <code>AgentVersion</code> ====
Определяет версию агента, работающего в данный момент на объекте.
Определяет версию агента, работающего в данный момент на объекте.
{| class="wikitable"
{| class="wikitable"
Строка 386: Строка 372:
!Описание
!Описание
|-
|-
|главный
|major
|целое число
|integer
|Номер основной версии.
|Номер основной версии.
|-
|-
|незначительный
|minor
|целое число
|integer
|Младший номер версии.
|Младший номер версии.
|-
|-
|ревизия
|revision
|целое число
|integer
|Номер ревизии.
|Номер ревизии.
|-
|-
|отметка времени
|timestamp
|нить
|string
|Строка временной метки: формат "ггггммдд-ччммсс
|Строка временной метки: формат "ггггммдд-ччммсс
|-
|-
|Исходная версия
|sourceRevision
|нить
|string
|Строковое представление номера версии SVN.
|Строковое представление номера версии SVN.
|}
|}


==== Объект _ <code>TechnologyInfo</code> ====
==== Объект <code>MonitoringState</code> ====
Определяет текущее состояние мониторинга объекта.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 413: Строка 400:
!Описание
!Описание
|-
|-
|тип
|actualMonitoringState
|нить
|string
| -
|Текущее фактическое состояние мониторинга объекта.
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|-
|версия
|actualMonitoringState
|нить
|string
| -
|Состояние мониторинга, ожидаемое от конфигурации
 
Элемент может содержать эти значения
 
* <code>OFF</code>
* <code>ON</code>
|-
|-
|версия
|restartRequired
|нить
|boolean
| -
|Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг
|}
|}


Строка 468: Строка 465:
         "string"
         "string"
       ],
       ],
       "dynatraceNodeIds": [
       "AstromkeyNodeIds": [
         "string"
         "string"
       ],
       ],
Строка 734: Строка 731:
         "string"
         "string"
       ],
       ],
       "dynatraceClusterIds": [
       "AstromkeyClusterIds": [
         "string"
         "string"
       ],
       ],
Строка 778: Строка 775:
       {
       {
         "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
         "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
         "name": "Dynatrace entity",
         "name": "Astromkey entity",
         "description": "Dynatrace entity for the REST API example"
         "description": "Astromkey entity for the REST API example"
       }
       }
     ],
     ],
Строка 827: Строка 824:
!Описание
!Описание
|-
|-
|Общее количество
|Total-Count
|целое число
|integer
|Предполагаемое количество результатов.
|Предполагаемое количество результатов.
|-
|-
|Клавиша следующей страницы
|Next-Page-Key
|нить
|string
|Курсор для следующей страницы результатов. Без него вы снова получите первую страницу.
|Курсор для следующей страницы результатов. Без него вы снова получите первую страницу.
|-
|-
|Размер страницы
|Page-Size
|нить
|string
|Максимальное количество результатов на странице.
|Максимальное количество результатов на странице.
|}
|}


== Пример ==
== Пример ==
В этом примере в запросе перечислены все процессы в вашей среде Dynatrace, обнаруженные за последние 5 минут .
В этом примере в запросе перечислены все процессы в вашей среде Ключ-АСТРОМ, обнаруженные за последние 5 минут .


Маркер API передается в заголовке авторизации .
Маркер API передается в заголовке авторизации .
Строка 847: Строка 844:
Результат усекается до двух записей.
Результат усекается до двух записей.


==== Завиток ====
==== Curl ====
  <code>curl -X GET \
  <code>curl -X GET \
   '<nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/processes?relativeTime=5mins'</nowiki> \
   '<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes?relativeTime=5mins'</nowiki> \
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>
   -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>


==== URL-адрес запроса ====
==== URL-адрес запроса ====
  <code><nowiki>https://mySampleEnv.live.dynatrace.com/api/v1/entity/infrastructure/processes?relativeTime=5mins</nowiki></code>
  <code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes?relativeTime=5mins</nowiki></code>


==== Тело ответа ====
==== Тело ответа ====

Текущая версия на 08:49, 13 октября 2022

Получает список всех процессов в вашей среде Ключ-АСТРОМ вместе с их параметрами и взаимосвязями.

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

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

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

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

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

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

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

Параметры

Срок ограничен максимальным периодом в 3 дня .

Параметр Тип Описание 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 по желанию
hostTag string [] Фильтрует процессы по узлу, на котором они запущены.

Укажите теги интересующего вас хоста.

query по желанию
host string [] Фильтрует процессы по узлу, на котором они запущены.

Укажите Ключ-АСТРОМ ID интересующего вас хоста.

Для указания нескольких хостов используйте следующий формат: host=hostID1&host=hostID2.

Применяется логика ИЛИ .

query по желанию
actualMonitoringState string Фильтрует процессы по фактическому состоянию мониторинга процесса.

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

  • OFF
  • ON
query по желанию
expectedMonitoringState string Фильтрует процессы по ожидаемому состоянию мониторинга процесса.

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

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

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

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

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

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

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

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

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

query по желанию

Ответ

Коды ответов

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

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

Объект ResponseBody

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

Объект ProcessGroupInstance

Параметры процесса.

Элемент Тип Описание
entityId string Идентификатор объекта Ключ-АСТРОМ требуемого объекта.
displayName string Имя объекта Ключ-АСТРОМ, отображаемое в пользовательском интерфейсе.
customizedName string Пользовательское имя объекта
discoveredName string Обнаруженное имя объекта
firstSeenTimestamp integer Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp integer Отметка времени последнего обнаружения объекта в миллисекундах UTC.
tags TagInfo[] Список тегов сущностей.
fromRelationships объект -
toRelationships объект -
metadata объект -
softwareTechnologies TechnologyInfo[] -
azureSiteName string -
versionedModules ProcessGroupInstanceModule[] -
managementZones EntityShortRepresentation[] Зоны управления, частью которых является объект.
modules string [] -
agentVersions AgentVersion[] Версии ЕдиныхАгентов, которые в настоящее время работают на объекте.
listenPorts integer [] -
bitness string -

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

  • 32bit
  • 64bit
azureHostName string -
monitoringState MonitoringState Определяет текущее состояние мониторинга объекта.

Объект TagInfo

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

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

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

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

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

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

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

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

Объект TechnologyInfo

Элемент Тип Описание
type string -
edition string -
version string -

Объект ProcessGroupInstanceModule

Элемент Тип Описание
name string -
version string -

Объект EntityShortRepresentation

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

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

Объект AgentVersion

Определяет версию агента, работающего в данный момент на объекте.

Элемент Тип Описание
major integer Номер основной версии.
minor integer Младший номер версии.
revision integer Номер ревизии.
timestamp string Строка временной метки: формат "ггггммдд-ччммсс
sourceRevision string Строковое представление номера версии SVN.

Объект MonitoringState

Определяет текущее состояние мониторинга объекта.

Элемент Тип Описание
actualMonitoringState string Текущее фактическое состояние мониторинга объекта.

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

  • OFF
  • ON
actualMonitoringState string Состояние мониторинга, ожидаемое от конфигурации

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

  • OFF
  • ON
restartRequired boolean Определяет, должен ли процесс быть перезапущен, чтобы включить мониторинг

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

[
  {
    "entityId": "string",
    "displayName": "string",
    "customizedName": "string",
    "discoveredName": "string",
    "firstSeenTimestamp": 1,
    "lastSeenTimestamp": 1,
    "tags": [
      {
        "context": "AWS",
        "key": "string",
        "value": "string"
      }
    ],
    "fromRelationships": {
      "isProcessOf": [
        "string"
      ],
      "isInstanceOf": [
        "string"
      ],
      "isNetworkClientOf": [
        "string"
      ]
    },
    "toRelationships": {
      "runsOnProcessGroupInstance": [
        "string"
      ],
      "isNetworkClientOf": [
        "string"
      ]
    },
    "metadata": {
      "hostGroups": [
        "string"
      ],
      "cloudFoundryAppIds": [
        "string"
      ],
      "AstromkeyNodeIds": [
        "string"
      ],
      "executables": [
        "string"
      ],
      "googleComputeEngineMetadata": {},
      "phpScripts": [
        "string"
      ],
      "awsEcsCluster": [
        "string"
      ],
      "declarativeId": [
        "string"
      ],
      "glassfishInstanceNames": [
        "string"
      ],
      "tibcoBusinessWorksEnginePropertyFiles": [
        "string"
      ],
      "jbossServerNames": [
        "string"
      ],
      "catalinaBaseValues": [
        "string"
      ],
      "mssqlInstanceName": [
        "string"
      ],
      "ibmIntegrationServerName": [
        "string"
      ],
      "varnishInstanceNames": [
        "string"
      ],
      "phpWorkingDirectories": [
        "string"
      ],
      "websphereLibertyServerName": [
        "string"
      ],
      "googleCloudProjects": [
        "string"
      ],
      "dockerContainerImageVersions": [
        "string"
      ],
      "hybrisConfigDirectories": [
        "string"
      ],
      "executablePaths": [
        "string"
      ],
      "awsEcrImageRegions": [
        "string"
      ],
      "tibcoBusinessWorksAppSpaceName": [
        "string"
      ],
      "springBootStartupClass": [
        "string"
      ],
      "weblogicDomainNames": [
        "string"
      ],
      "elasticSearchNodeNames": [
        "string"
      ],
      "tibcoBWEnginePropertyFilePaths": [
        "string"
      ],
      "kubernetesContainerNames": [
        "string"
      ],
      "rubyAppRootPaths": [
        "string"
      ],
      "ibmImsMessageProcessingRegions": [
        "string"
      ],
      "linkage": [
        "string"
      ],
      "cloudfoundryMetadata": {},
      "oracleSid": [
        "string"
      ],
      "awsEcsFamily": [
        "string"
      ],
      "commandLineArgs": [
        "string"
      ],
      "aspDotNetCoreApplicationPaths": [
        "string"
      ],
      "awsEcrImageAccountIds": [
        "string"
      ],
      "springBootAppName": [
        "string"
      ],
      "websphereClusterNames": [
        "string"
      ],
      "springBootProfileName": [
        "string"
      ],
      "kubernetesAnnotations": {},
      "websphereServerNames": [
        "string"
      ],
      "catalinaHomeValues": [
        "string"
      ],
      "glassfishDomainNames": [
        "string"
      ],
      "kubernetesBasePodNames": [
        "string"
      ],
      "weblogicClusterNames": [
        "string"
      ],
      "javaMainModules": [
        "string"
      ],
      "kubernetesPodUids": [
        "string"
      ],
      "awsEcsContainerName": [
        "string"
      ],
      "coldfusionJvmConfigFiles": [
        "string"
      ],
      "dotnetCommandPath": [
        "string"
      ],
      "tibcoBusinessWorksDomainName": [
        "string"
      ],
      "elasticSearchClusterNames": [
        "string"
      ],
      "nodejsScriptNames": [
        "string"
      ],
      "iisRoleNames": [
        "string"
      ],
      "apacheSparkMasterIpAddresses": [
        "string"
      ],
      "weblogicNames": [
        "string"
      ],
      "rubyScriptPaths": [
        "string"
      ],
      "ibmImsSoapGwName": [
        "string"
      ],
      "nodejsAppBaseDirectories": [
        "string"
      ],
      "softwareAgProductPropertyName": [
        "string"
      ],
      "awsEcsRevision": [
        "string"
      ],
      "ibmImsControlRegions": [
        "string"
      ],
      "javaMainClasses": [
        "string"
      ],
      "cassandraClusterNames": [
        "string"
      ],
      "softwareAgInstallRoot": [
        "string"
      ],
      "cloudFoundryAppNames": [
        "string"
      ],
      "cloudFoundrySpaceNames": [
        "string"
      ],
      "pluginMetadata": {},
      "ibmIntegrationNodeName": [
        "string"
      ],
      "dockerContainerNames": [
        "string"
      ],
      "ibmCtgName": [
        "string"
      ],
      "tibcoBusinessWorksCeAppName": [
        "string"
      ],
      "kubernetesFullPodNames": [
        "string"
      ],
      "apacheConfigPaths": [
        "string"
      ],
      "tibcoBusinessWorksAppNodeName": [
        "string"
      ],
      "tibcoBusinessWorksCeVersion": [
        "string"
      ],
      "dotNetCommands": [
        "string"
      ],
      "googleAppEngineServices": [
        "string"
      ],
      "kubernetesNamespaces": [
        "string"
      ],
      "hybrisDataDirectories": [
        "string"
      ],
      "envVariables": {},
      "javaJarFiles": [
        "string"
      ],
      "javaJarPaths": [
        "string"
      ],
      "dockerContainerIds": [
        "string"
      ],
      "cloudFoundrySpaceIds": [
        "string"
      ],
      "ruleResult": [
        "string"
      ],
      "kubernetesRuleResult": [
        "string"
      ],
      "jbossModes": [
        "string"
      ],
      "awsLambdaFunctionNames": [
        "string"
      ],
      "cloudFoundryInstanceIndexes": [
        "string"
      ],
      "hybrisBinDirectories": [
        "string"
      ],
      "weblogicHomeValues": [
        "string"
      ],
      "jbossHomes": [
        "string"
      ],
      "AstromkeyClusterIds": [
        "string"
      ],
      "googleAppEngineInstances": [
        "string"
      ],
      "websphereNodeNames": [
        "string"
      ],
      "agentValueMetadata": {},
      "iisAppPools": [
        "string"
      ],
      "ibmImsConnectRegions": [
        "string"
      ],
      "dockerContainerImageNames": [
        "string"
      ],
      "tibcoBusinessWorksHome": [
        "string"
      ],
      "ibmCicsRegion": [
        "string"
      ],
      "serviceNames": [
        "string"
      ],
      "websphereCellNames": [
        "string"
      ],
      "nodejsAppNames": [
        "string"
      ],
      "equinoxConfigPath": [
        "string"
      ],
      "awsRegions": [
        "string"
      ]
    },
    "managementZones": [
      {
        "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
        "name": "Astromkey entity",
        "description": "Astromkey entity for the REST API example"
      }
    ],
    "modules": [
      "string"
    ],
    "monitoringState": {
      "actualMonitoringState": "OFF",
      "expectedMonitoringState": "OFF",
      "restartRequired": true
    },
    "azureHostName": "string",
    "azureSiteName": "string",
    "listenPorts": [
      1
    ],
    "versionedModules": [
      {
        "name": "string",
        "version": "string"
      }
    ],
    "agentVersions": [
      {
        "major": 1,
        "minor": 1,
        "revision": 1,
        "timestamp": "string",
        "sourceRevision": "string"
      }
    ],
    "softwareTechnologies": [
      {
        "type": "string",
        "edition": "string",
        "version": "string"
      }
    ],
    "bitness": "32bit"
  }
]

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

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

Пример

В этом примере в запросе перечислены все процессы в вашей среде Ключ-АСТРОМ, обнаруженные за последние 5 минут .

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

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

Curl

curl -X GET \
  'https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes?relativeTime=5mins' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/infrastructure/processes?relativeTime=5mins

Тело ответа

[
  {
    "entityId": "PROCESS_GROUP_INSTANCE-EC9688429EB24B6B",
    "displayName": "Apache Web Server apache2",
    "discoveredName": "Apache Web Server apache2",
    "firstSeenTimestamp": 1464951001104,
    "lastSeenTimestamp": 1544024894801,
    "tags": [],
    "fromRelationships": {
      "isProcessOf": [
        "HOST-5FD609AD6757BE7D"
      ],
      "isInstanceOf": [
        "PROCESS_GROUP-B34081EFF9E5F516"
      ]
    },
    "toRelationships": {
      "runsOnProcessGroupInstance": [
        "SERVICE-C3173FEB08025322",
        "SERVICE-B8C88BAA442098CF"
      ]
    },
    "metadata": {
      "commandLineArgs": [
        "/usr/sbin/apache2 -k start"
      ],
      "executables": [
        "apache2"
      ],
      "executablePaths": [
        "/usr/sbin/apache2"
      ],
      "apacheConfigPaths": [
        "/etc/apache2/apache2.conf"
      ]
    },
    "softwareTechnologies": [
      {
        "type": "PHP",
        "edition": "Apache",
        "version": "5.5.9"
      },
      {
        "type": "APACHE_HTTPD",
        "edition": null,
        "version": "2.4.7"
      },
      {
        "type": "SQLITE",
        "edition": null,
        "version": null
      }
    ],
    "listenPorts": [
      443,
      80
    ],
    "bitness": "64bit",
    "monitoringState": {
      "actualMonitoringState": "ON",
      "expectedMonitoringState": "ON",
      "restartRequired": false
    },
    "agentVersions": [
      {
        "major": 1,
        "minor": 157,
        "revision": 167,
        "timestamp": "20181127-152923",
        "sourceRevision": ""
      }
    ]
  },
  {
    "entityId": "PROCESS_GROUP_INSTANCE-C43E52A77ED8F809",
    "displayName": "OneAgent network monitoring",
    "discoveredName": "OneAgent network monitoring",
    "firstSeenTimestamp": 1543571247077,
    "lastSeenTimestamp": 1544024847791,
    "tags": [
      {
        "context": "CONTEXTLESS",
        "key": "sample tag"
      }
    ],
    "fromRelationships": {
      "isProcessOf": [
        "HOST-CCEA78FDE257A4B9"
      ],
      "isInstanceOf": [
        "PROCESS_GROUP-E2B399E9E7FF43C0"
      ],
      "isNetworkClientOf": [
        "PROCESS_GROUP_INSTANCE-9E7865921C2C984E"
      ]
    },
    "toRelationships": {},
    "metadata": {
      "hostGroups": [
        "wazuh"
      ]
    },
    "softwareTechnologies": [
      {
        "type": "APMNG",
        "edition": null,
        "version": null
      }
    ],
    "bitness": "64bit",
    "monitoringState": {
      "actualMonitoringState": "ON",
      "expectedMonitoringState": "ON",
      "restartRequired": false
    }
  }
]

Код ответа

200