GET тип объектов

API АппОптима / Эндпойнты среды / Развёртывание / Отслеживаемые объекты v2 / GET тип объектов

Перечисляет возможные свойства объекта указанного типа. Обратите внимание, что это заполнители, показывающие, какие свойства может иметь объект, а не фактические свойства. Чтобы просмотреть фактические свойства объекта, используйте запрос GET сущности .

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

GET	АппОптима	https://{your-domain}/e/{your-environment-id}/api/v2/entityTypes/{type}
	Cреда АктивногоШлюза	https://{your-activegate-domain}/e/{your-environment-id}/api/v2/entityTypes/{type}

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

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

Параметры

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

Ответ

Коды ответов

Код	Тип	Описание
200	EntityType	Успех
400		Не удалось. Запрошенный тип отслеживаемого объекта не экспортируется или не существует.

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

Объект EntityType

Список свойств отслеживаемого типа объекта.

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

Объект ToPosition

Позиция TO отношения.

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

Объект FromPosition

Позиция FROM отношения.

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

Объект EntityTypePropertyDto

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

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

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

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

Пример

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

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

Curl

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

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

https://mySampleEnv.live.ruscomtech.ru/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