API мониторинга объектов — GET-запрос типа объекта

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

API мониторинга объектов — GET-запрос типа объекта

Отображает возможные свойства сущности указанного типа. Обратите внимание, что это лишь заполнители, показывающие, какими свойствами может обладать сущность, а не фактические свойства. Для просмотра фактических свойств сущности используйте GET-запрос к сущности.

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

SaaS: https://{your-environment-id}.live.astromkey.com/api/v2/entityTypes/{type}

Среда Активного Шлюза / Кластер Активного Шлюза: https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/entityTypes/{type}

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

Для выполнения этого запроса вам потребуется токен доступа с областью действия entities.read.

Чтобы узнать, как получить и использовать его, см. раздел «Токены и аутентификация».

Параметры

Параметр Тип Описание В Необходимый
type string Требуемый тип сущности. path Необходимый

Ответ

Коды ответов

Код Тип Описание
200 Тип сущности Успех
400 - Сбой. Запрошенный тип отслеживаемого объекта не подлежит экспорту или не существует.
4XX Оболочка ошибки Ошибка на стороне клиента.
5XX Оболочка ошибки Ошибка на стороне сервера.

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

Объект EntityType

Список свойств отслеживаемого типа сущности.

Элемент Тип Описание
dimensionKey string Ключ измерения, используемый в метриках для этого отслеживаемого объекта.
displayName string Отображаемое имя отслеживаемого объекта.
entityLimitExceeded boolean Указывает, превышен ли лимит создания сущностей для данного типа. Если значение равно true, Ключ-АСТРОМ автоматически запускает процесс очистки для этого типа сущностей. Новые сущности будут по-прежнему создаваться, и никаких действий не требуется. Это относится только к встроенным типам. Для обобщенных типов создание и обновление блокируется. Обобщенный тип можно распознать по наличию двоеточия в имени, например, my:type.
fromRelationships ToPosition [] Список возможных взаимосвязей, в которых отслеживаемый тип сущности занимает позицию ОТ.
managementZones string Заполнитель для списка зон управления реального объекта.
properties EntityTypePropertyDto [] Список дополнительных свойств отслеживаемого типа сущности.
tags string Заполнитель для списка тегов фактического объекта.
toRelationships FromPosition [] Список возможных взаимосвязей, в которых отслеживаемый тип сущности занимает позицию TO.
type string Тип контролируемого объекта.

Объект ToPosition

Позиция «ТО» в отношениях.

Элемент Тип Описание
id string Идентификатор связи.
toTypes string [] Список типов контролируемых объектов, которые могут занимать позицию TO.

Объект EntityTypePropertyDto

Свойство контролируемого объекта.

Элемент Тип Описание
displayName string Отображаемое название свойства.
id string Идентификатор свойства.
type string Тип свойства.

Объект FromPosition

Позиция «откуда» в отношениях.

Элемент Тип Описание
fromTypes string [] Список отслеживаемых типов сущностей, которые могут занимать позицию FROM.
id string Идентификатор связи.

Модели JSON тела ответа

Пример ответа

{
  "entityLimitExceeded": "false",
  "fromRelationships": [
    {
      "id": "RUNS_ON_RESOURCE",
      "toTypes": [
        "CUSTOM_DEVICE"
      ]
    },
    {
      "id": "IS_NETWORK_CLIENT_OF_HOST",
      "toTypes": [
        "HOST",
        "CUSTOM_DEVICE"
      ]
    }
  ],
  "managementZones": "placeholder for management zones",
  "properties": [
    {
      "id": "BITNESS",
      "type": "Enum"
    },
    {
      "id": "CPU_CORES",
      "type": "Number"
    }
  ],
  "tags": "placeholder for tags",
  "toRelationships": [
    {
      "fromTypes": [
        "DISK"
      ],
      "id": "IS_DISK_OF"
    },
    {
      "fromTypes": [
        "VMWARE_DATACENTER",
        "GEOLOC_SITE"
      ],
      "id": "IS_SITE_OF"
    }
  ],
  "type": "HOST"
}

Пример

В этом примере запрос перечисляет все возможные свойства сущностей типа PROCESS_GROUP_INSTANCE.

API-токен передается в заголовке Authorization.

cURL

curl -L -X GET 'https://mySampleEnv.live.astromkey.com/api/v2/entityTypes/PROCESS_GROUP_INSTANCE' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL запроса

https://mySampleEnv.live.astromkey.com/api/v2/entityTypes/PROCESS_GROUP_INSTANCE

Тело ответа

{
  "type": "PROCESS_GROUP_INSTANCE",
  "properties": [
    {
      "id": "appVersion",
      "type": "String"
    },
    {
      "id": "awsNameTag",
      "type": "String"
    },
    {
      "id": "azureHostName",
      "type": "String"
    },
    {
      "id": "azureSiteName",
      "type": "String"
    },
    {
      "id": "bitness",
      "type": "Enum"
    },
    {
      "id": "boshName",
      "type": "String"
    },
    {
      "id": "conditionalName",
      "type": "String"
    },
    {
      "id": "customPgMetadata",
      "type": "Map"
    },
    {
      "id": "customizedName",
      "type": "String"
    },
    {
      "id": "gardenApplicationNames",
      "type": "List"
    },
    {
      "id": "gcpZone",
      "type": "String"
    },
    {
      "id": "internalName",
      "type": "String"
    },
    {
      "id": "isDockerized",
      "type": "Boolean"
    },
    {
      "id": "jvmClrVersion",
      "type": "String"
    },
    {
      "id": "jvmVendor",
      "type": "String"
    },
    {
      "id": "listenPorts",
      "type": "List"
    },
    {
      "id": "metadata",
      "type": "List"
    },
    {
      "id": "modules",
      "type": "List"
    },
    {
      "id": "oneAgentCustomHostName",
      "type": "String"
    },
    {
      "id": "processType",
      "type": "Enum"
    },
    {
      "id": "softwareTechnologies",
      "type": "List"
    },
    {
      "id": "versionedModules",
      "type": "List"
    }
  ],
  "tags": "List",
  "managementZones": "List",
  "fromRelationships": [
    {
      "id": "isProcessOf",
      "toTypes": [
        "HOST"
      ]
    },
    {
      "id": "runsOnResource",
      "toTypes": [
        "CUSTOM_DEVICE"
      ]
    },
    {
      "id": "isInstanceOf",
      "toTypes": [
        "PROCESS_GROUP"
      ]
    },
    {
      "id": "talksWithCandidate",
      "toTypes": [
        "HOST"
      ]
    },
    {
      "id": "isNetworkClientOf",
      "toTypes": [
        "CUSTOM_DEVICE",
        "PROCESS_GROUP_INSTANCE"
      ]
    }
  ],
  "toRelationships": [
    {
      "id": "runsOnProcessGroupInstance",
      "fromTypes": [
        "SERVICE"
      ]
    },
    {
      "id": "isHostGroupOf",
      "fromTypes": [
        "HOST_GROUP"
      ]
    },
    {
      "id": "isNetworkClientOf",
      "fromTypes": [
        "CUSTOM_DEVICE",
        "PROCESS_GROUP_INSTANCE"
      ]
    },
    {
      "id": "candidateTalksWith",
      "fromTypes": [
        "HOST"
      ]
    }
  ]
}

Код ответа: 200

Источник — https://doc.ruscomtech.ru/index.php?title=API_мониторинга_объектов_—_GET-запрос_типа_объекта&oldid=6477