Получает список всех служб в вашей среде Ключ-Астром вместе с их параметрами и взаимосвязями.
Полный список может быть длинным, поэтому вы можете сузить его, указав параметры фильтра, такие как теги. См. раздел Параметры для более подробной информации.
Вы можете дополнительно ограничить вывод с помощью нумерации страниц:
- Укажите количество результатов на странице в параметре запроса pageSize .
- Затем используйте курсор из заголовка ответа Next-Page-Key в параметре запроса nextPageKey для получения последующих страниц.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v1/entity/services
|
| Cреда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/services
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с проблемой доступа и каналом событий, метриками и областью топологии ( DataExport) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
Срок ограничен максимальным периодом в 3 дня .
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| startTimestamp | string | Метка времени начала запрошенного таймфрейма в миллисекундах (UTC).
Если не задано, используется отставание на 72 часа. |
query | по желанию |
| endTimestamp | string | Отметка времени окончания запрошенного таймфрейма в миллисекундах (UTC).
Если не задано, используется текущая метка времени. Срок не должен превышать 3 дней. |
query | по желанию |
| relativeTime | string | Относительный период времени, начиная с настоящего времени.
Элемент может содержать эти значения
|
query | по желанию |
| tag | string [] | Фильтрует результирующий набор сервисов по указанному тегу. Вы можете указать несколько тегов в следующем формате: tag=tag1&tag=tag2. Сервис должен соответствовать всем указанным тегам.
В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: |
query | по желанию |
| entity | string [] | Фильтры приводят только к указанным службам.
Чтобы указать несколько сервисов, используйте следующий формат: |
query | по желанию |
| managementZone | string | Возвращайте только те службы, которые входят в указанную зону управления. | query | по желанию |
| includeDetails | boolean | Включает ( true) или исключает ( false) детали, которые запрашиваются у связанных объектов.
Исключение сведений может ускорить запросы. Если не установлено, то |
query | по желанию |
| pageSize | string | Количество услуг на странице результатов.
Если не задано, нумерация страниц не используется, и результат содержит все сервисы, соответствующие заданным критериям фильтрации. |
query | по желанию |
| nextPageKey | string | Курсор для следующей страницы результатов. Вы можете найти его в заголовке Next-Page-Key предыдущего ответа.
Если вы используете нумерацию страниц, первая страница всегда возвращается без этого курсора. Вы должны оставить все остальные параметры запроса такими, какими они были в первом запросе, чтобы получить последующие страницы. |
query | по желанию |
Заголовки ответа
| Заголовок | Тип | Описание |
|---|---|---|
| Total-Count | string | Предполагаемое количество результатов. |
| Next-Page-Key | string | Курсор для следующей страницы результатов. Без него вы снова получите первую страницу. |
| Page-Size | string | Максимальное количество результатов на странице. |
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 200 | Service[] | Успех |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |
Объекты тела ответа
Объект ResponseBody
Объект не предоставляет никаких параметров.
Объект Service
| Элемент | Тип | Описание |
|---|---|---|
| entityId | string | Идентификатор объекта string требуемого объекта. |
| displayName | string | Имя объекта string, отображаемое в пользовательском интерфейсе. |
| customizedName | string | Пользовательское имя объекта |
| discoveredName | string | Обнаруженное имя объекта |
| firstSeenTimestamp | string | Отметка времени первого обнаружения объекта в миллисекундах UTC. |
| lastSeenTimestamp | string | Отметка времени последнего обнаружения объекта в миллисекундах UTC. |
| tags | TagInfo[] | Список тегов сущностей. |
| fromRelationships | объект | - |
| toRelationships | объект | - |
| path | string | - |
| webServerName | string | - |
| ibmCtgServerName | string | Имя шлюза транзакций IBM CICS. |
| akkaActorSystem | string | Услуги актерской системы akka. |
| contextRoot | string | - |
| port | string | - |
| ibmCtgGatewayUrl | string | URL-адрес шлюза IBM CTG. |
| databaseName | string | - |
| ipAddresses | string [] | - |
| webServiceName | string | - |
| className | string | - |
| webApplicationId | string | - |
| managementZones | EntityShortRepresentation[] | Зоны управления, частью которых является объект. |
| agentTechnologyType | string | -
Элемент может содержать эти значения
|
| remoteEndpoint | string | Конечная точка удаленной службы. |
| softwareTechnologies | TechnologyInfo[] | - |
| webServiceNamespace | string | - |
| remoteServiceName | string | Имя удаленной службы. |
| serviceTechnologyTypes | string [] | - |
| databaseHostNames | string [] | - |
| esbApplicationName | string | Имя приложения ESB. |
| serviceType | string | -
Элемент может содержать эти значения
|
| iibApplicationName | string | Имя приложения IIB. |
| isExternalService | boolean | - |
| databaseVendor | string | - |
Объект TagInfo
Тег сущности string.
| Элемент | Тип | Описание |
|---|---|---|
| context | string | Происхождение тега, например AWS или Cloud Foundry.
Пользовательские теги используют это Элемент может содержать эти значения
|
| key | string | Ключ тега.
Пользовательские теги имеют значение тега здесь. |
| value | string | Значение тега.
Не применимо к пользовательским тегам. |
Объект EntityShortRepresentation
Краткое представление объекта string.
| Элемент | Тип | Описание |
|---|---|---|
| id | string | Идентификатор объекта string. |
| name | string | Имя объекта string. |
| description | string | Краткое описание сущности 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"
}
]
Пример
В этом примере в запросе перечислены все службы среды, обнаруженные за последние 5 минут .
Маркер API передается в заголовке авторизации .
Результат усекается до двух записей.
Curl
curl -X GET \
'https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
URL-адрес запроса
https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services?relativeTime=5mins
Тело ответа
[
{
"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": 1544025169570,
"tags": [
{
"context": "CONTEXTLESS",
"key": "Sample tag"
}
],
"fromRelationships": {
"runsOnProcessGroupInstance": [
"PROCESS_GROUP_INSTANCE-165E2E1655782C30",
"PROCESS_GROUP_INSTANCE-2E41AD6095ACE67B",
"PROCESS_GROUP_INSTANCE-3E537F0F455E9757"
],
"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
}
]
},
{
"entityId": "SERVICE-52AC624D70C377BC",
"displayName": "Requests to public networks",
"discoveredName": "Requests to public networks",
"firstSeenTimestamp": 1421376505750,
"lastSeenTimestamp": 1544025153570,
"tags": [],
"fromRelationships": {},
"toRelationships": {
"calls": [
"SERVICE-635F6C4CAD07BC56",
"SERVICE-74C7ACD74FA27688",
"SERVICE-C7790E5EDD1F895E"
]
},
"agentTechnologyType": "N/A",
"serviceType": "WebRequest"
}
]
Код ответа
200