GET сервис

Получает параметры указанной службы.

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

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

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

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

Параметры

Параметр	Тип	Описание	В	Необходимый
meIdentifier	string	Идентификатор объекта АппОптима требуемой службы.	дорожка	требуется

Ответ

Коды ответов

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

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

Объект Service

Элемент	Тип	Описание
entityId	string	Идентификатор объекта АппОптима требуемого объекта.
displayName	string	Имя объекта АппОптима, отображаемое в пользовательском интерфейсе.
customizedName	string	Пользовательское имя объекта
discoveredName	string	Обнаруженное имя объекта
firstSeenTimestamp	integer	Отметка времени первого обнаружения объекта в миллисекундах UTC.
lastSeenTimestamp	integer	Отметка времени последнего обнаружения объекта в миллисекундах UTC.
tags	TagInfo[]	Список тегов сущностей.
fromRelationships	объект	-
toRelationships	объект	-
path	string	-
webServerName	string	-
ibmCtgServerName	string	Имя шлюза транзакций IBM CICS.
akkaActorSystem	string	Услуги системы akka actor.
contextRoot	string	-
port	integer	-
ibmCtgGatewayUrl	string	URL-адрес шлюза IBM CTG.
databaseName	string	-
ipAddresses	string []	-
webServiceName	string	-
className	string	-
webApplicationId	string	-
managementZones	EntityShortRepresentation[]	Зоны управления, частью которых является объект.
agentTechnologyType	string	- Элемент может содержать эти значения APACHE DOTNET DUMPPROC GO IIS JAVA LOG_ANALYTICS N/A NET NETTRACER NGINX NODEJS OPENTRACINGNATIVE OS PHP PLUGIN PROCESS PYTHON REMOTE_PLUGIN RUBY SDK UPDATER VARNISH WSMB Z
remoteEndpoint	string	Конечная точка удаленной службы.
softwareTechnologies	TechnologyInfo[]	-
webServiceNamespace	string	-
remoteServiceName	string	Имя удаленной службы.
serviceTechnologyTypes	string []	-
databaseHostNames	string []	-
esbApplicationName	string	Имя приложения ESB.
serviceType	string	- Элемент может содержать эти значения AMP Cics CicsInteraction CustomApplication Database EnterpriseServiceBus External Ims ImsInteraction Messaging Method Mobile Process QueueInteraction QueueListener RemoteCall Rmi SaasVendor Span Unknown WebRequest WebService WebSite ZosConnect
iibApplicationName	string	Имя приложения IIB.
isExternalService	логический	-
databaseVendor	string	-

Объект 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	Краткое описание сущности АппОптима.

Объект _ TechnologyInfo

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

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

<{
  "entityId": "string",
  "displayName": "string",
  "customizedName": "string",
  "discoveredName": "string",
  "firstSeenTimestamp": 1,
  "lastSeenTimestamp": 1,
  "tags": [
    {
      "context": "AWS",
      "key": "string",
      "value": "string"
    }
  ],
  "fromRelationships": {
    "runsOnProcessGroupInstance": [
      "string"
    ],
    "calls": [
      "string"
    ],
    "runsOn": [
      "string"
    ]
  },
  "toRelationships": {
    "calls": [
      "string"
    ]
  },
  "path": "string",
  "webServerName": "string",
  "ibmCtgServerName": "string",
  "akkaActorSystem": "string",
  "contextRoot": "string",
  "port": 1,
  "ibmCtgGatewayUrl": "string",
  "databaseName": "string",
  "ipAddresses": [
    "string"
  ],
  "webServiceName": "string",
  "className": "string",
  "webApplicationId": "string",
  "managementZones": [
    {
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Astromkey entity",
      "description": "Astromkey entity for the REST API example"
    }
  ],
  "agentTechnologyType": "APACHE",
  "remoteEndpoint": "string",
  "softwareTechnologies": [
    {
      "type": "string",
      "edition": "string",
      "version": "string"
    }
  ],
  "webServiceNamespace": "string",
  "remoteServiceName": "string",
  "serviceTechnologyTypes": [
    "string"
  ],
  "databaseHostNames": [
    "string"
  ],
  "esbApplicationName": "string",
  "serviceType": "AMP",
  "iibApplicationName": "string",
  "isExternalService": true,
  "databaseVendor": "string"
}

Пример

В этом примере запрос получает сведения о PHP-FPM через сервис доменного сокета /run/php7-fpm.sock с идентификатором SERVICE-72503CBDD2AEF066 .

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

Curl

<curl -X GET \
  'https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

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

https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066

Тело ответа

<{
  "entityId": "SERVICE-72503CBDD2AEF066",
  "displayName": "PHP-FPM via domain socket /run/php7-fpm.sock",
  "discoveredName": "PHP-FPM via domain socket /run/php7-fpm.sock",
  "firstSeenTimestamp": 1505902015554,
  "lastSeenTimestamp": 1546010106998,
  "tags": [],
  "fromRelationships": {
    "runsOnProcessGroupInstance": [
      "PROCESS_GROUP_INSTANCE-9BA70456D770536E",
      "PROCESS_GROUP_INSTANCE-7E988C3503AE8803"
    ],
    "runsOn": [
      "PROCESS_GROUP-E5C3CC7EC1F80B5B"
    ]
  },
  "toRelationships": {
    "calls": [
      "SERVICE-5304CCF4AFBFF35E"
    ]
  },
  "agentTechnologyType": "N/A",
  "serviceType": "WebRequest",
  "softwareTechnologies": [
    {
      "type": "SQLITE",
      "edition": null,
      "version": null
    },
    {
      "type": "PHP",
      "edition": "FPM",
      "version": "7.0.32"
    },
    {
      "type": "PHP_FPM",
      "edition": null,
      "version": null
    }
  ]
}

Код ответа

200