GET сервис - История изменений

IKuznetsov в 18:21, 2 января 2025

2025-01-02T18:21:08Z

← Предыдущая версия		Версия от 18:21, 2 января 2025
Строка 366:		Строка 366:
	{		{
	"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",		"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
	"name": "~~Astromkey~~ entity",		"name": "AppOptima entity",
	"description": "~~Astromkey~~ entity for the REST API example"		"description": "AppOptima entity for the REST API example"
	}		}
	],		],

IKuznetsov в 12:47, 29 декабря 2024

2024-12-29T12:47:59Z

← Предыдущая версия		Версия от 12:47, 29 декабря 2024
Строка 1:		Строка 1:
			'''''[[API АппОптима]] / [[API АппОптима\|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%95%D0%B4%D0%B8%D0%BD%D1%8B%D0%B9%D0%90%D0%B3%D0%B5%D0%BD%D1%82%20%D0%BD%D0%B0%20%D1%85%D0%BE%D1%81%D1%82%D0%B5-,%D0%A2%D0%BE%D0%BF%D0%BE%D0%BB%D0%BE%D0%B3%D0%B8%D1%8F,-%D0%9F%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F Топология] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=POST%20%D1%82%D1%8D%D0%B3%D0%BE%D0%B2-,%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B,-GET%20%D0%B2%D1%81%D0%B5%20%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D1%8B Сервисы] / GET сервис'''''

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

IKuznetsov в 14:09, 26 декабря 2024

2024-12-26T14:09:26Z

← Предыдущая версия		Версия от 14:09, 26 декабря 2024
Строка 24:		Строка 24:
	\|meIdentifier		\|meIdentifier
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемой службы.		\|Идентификатор объекта АппОптима требуемой службы.
	\|дорожка		\|дорожка
	\|требуется		\|требуется
Строка 52:		Строка 52:
	\|entityId		\|entityId
	\|string		\|string
	\|Идентификатор объекта ~~Ключ-АСТРОМ~~ требуемого объекта.		\|Идентификатор объекта АппОптима требуемого объекта.
	\|-		\|-
	\|displayName		\|displayName
	\|string		\|string
	\|Имя объекта ~~Ключ-АСТРОМ~~, отображаемое в пользовательском интерфейсе.		\|Имя объекта АппОптима, отображаемое в пользовательском интерфейсе.
	\|-		\|-
	\|customizedName		\|customizedName
Строка 241:		Строка 241:

	==== Объект <code>TagInfo</code> ====		==== Объект <code>TagInfo</code> ====
	Тег сущности ~~Ключ-АСТРОМ~~.		Тег сущности АппОптима.
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент
Строка 278:		Строка 278:

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

Строка 390:		Строка 390:
	"isExternalService": true,		"isExternalService": true,
	"databaseVendor": "string"		"databaseVendor": "string"
	}~~</code>~~		}

	== Пример ==		== Пример ==
Строка 400:		Строка 400:
	<curl -X GET \		<curl -X GET \
	'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066'</nowiki> \		'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \~~</code>~~		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \

	==== URL-адрес запроса ====		==== URL-адрес запроса ====
Строка 446:		Строка 446:
	}		}
	]		]
	}~~</code>~~		}

	==== Код ответа ====		==== Код ответа ====
	200		200

IKuznetsov в 09:18, 26 декабря 2024

2024-12-26T09:18:41Z

← Предыдущая версия		Версия от 09:18, 26 декабря 2024
Строка 4:		Строка 4:
	{\| class="wikitable"		{\| class="wikitable"
	\| rowspan="2" \|GET		\| rowspan="2" \|GET
	\|~~Managed~~		\|АппОптима
	\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code>		\|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code>
	\|-		\|-
Строка 317:		Строка 317:

	=== JSON-модель тела ответа ===		=== JSON-модель тела ответа ===
	<~~code>~~{		<{
	"entityId": "string",		"entityId": "string",
	"displayName": "string",		"displayName": "string",
Строка 398:		Строка 398:

	==== Curl ====		==== Curl ====
	<~~code>~~curl -X GET \		<curl -X GET \
	'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066'</nowiki> \		'<nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066'</nowiki> \
	-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>		-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \</code>
Строка 406:		Строка 406:

	==== Тело ответа ====		==== Тело ответа ====
	<~~code>~~{		<{
	"entityId": "SERVICE-72503CBDD2AEF066",		"entityId": "SERVICE-72503CBDD2AEF066",
	"displayName": "PHP-FPM via domain socket /run/php7-fpm.sock",		"displayName": "PHP-FPM via domain socket /run/php7-fpm.sock",

ENetrebin: Новая страница: «Получает параметры указанной службы. Запрос создает `application/json`полезную нагрузку....»

2022-10-13T11:28:27Z

Новая страница: «Получает параметры указанной службы. Запрос создает <code>application/json</code>полезную нагрузку....»

Новая страница

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

Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/entity/services/{meIdentifier}</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Необходимый
|-
|meIdentifier
|string
|Идентификатор объекта Ключ-АСТРОМ требуемой службы.
|дорожка
|требуется
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|Service
|Успех
|}

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

==== Объект <code>Service</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|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
| -
Элемент может содержать эти значения

* <code>APACHE</code>
* <code>DOTNET</code>
* <code>DUMPPROC</code>
* <code>GO</code>
* <code>IIS</code>
* <code>JAVA</code>
* <code>LOG_ANALYTICS</code>
* <code>N/A</code>
* <code>NET</code>
* <code>NETTRACER</code>
* <code>NGINX</code>
* <code>NODEJS</code>
* <code>OPENTRACINGNATIVE</code>
* <code>OS</code>
* <code>PHP</code>
* <code>PLUGIN</code>
* <code>PROCESS</code>
* <code>PYTHON</code>
* <code>REMOTE_PLUGIN</code>
* <code>RUBY</code>
* <code>SDK</code>
* <code>UPDATER</code>
* <code>VARNISH</code>
* <code>WSMB</code>
* <code>Z</code>
|-
|remoteEndpoint
|string
|Конечная точка удаленной службы.
|-
|softwareTechnologies
|TechnologyInfo[]
| -
|-
|webServiceNamespace
|string
| -
|-
|remoteServiceName
|string
|Имя удаленной службы.
|-
|serviceTechnologyTypes
|string []
| -
|-
|databaseHostNames
|string []
| -
|-
|esbApplicationName
|string
|Имя приложения ESB.
|-
|serviceType
|string
| -
Элемент может содержать эти значения

* <code>AMP</code>
* <code>Cics</code>
* <code>CicsInteraction</code>
* <code>CustomApplication</code>
* <code>Database</code>
* <code>EnterpriseServiceBus</code>
* <code>External</code>
* <code>Ims</code>
* <code>ImsInteraction</code>
* <code>Messaging</code>
* <code>Method</code>
* <code>Mobile</code>
* <code>Process</code>
* <code>QueueInteraction</code>
* <code>QueueListener</code>
* <code>RemoteCall</code>
* <code>Rmi</code>
* <code>SaasVendor</code>
* <code>Span</code>
* <code>Unknown</code>
* <code>WebRequest</code>
* <code>WebService</code>
* <code>WebSite</code>
* <code>ZosConnect</code>
|-
|iibApplicationName
|string
|Имя приложения IIB.
|-
|isExternalService
|логический
| -
|-
|databaseVendor
|string
| -
|}

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

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

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

* <code>AWS</code>
* <code>AWS_GENERIC</code>
* <code>AZURE</code>
* <code>CLOUD_FOUNDRY</code>
* <code>CONTEXTLESS</code>
* <code>ENVIRONMENT</code>
* <code>GOOGLE_CLOUD</code>
* <code>KUBERNETES</code>
|-
|key
|string
|Ключ тега.

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

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

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

==== Объект _ <code>TechnologyInfo</code> ====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|type
|string
| -
|-
|edition
|string
| -
|-
|version
|string
| -
|}

=== JSON-модель тела ответа ===
<code>{
"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"
}</code>

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

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

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

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/entity/services/SERVICE-72503CBDD2AEF066</nowiki></code>

==== Тело ответа ====
<code>{
"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
}
]
}</code>

==== Код ответа ====
200

GET сервис - История изменений

IKuznetsov в 18:21, 2 января 2025

IKuznetsov в 12:47, 29 декабря 2024

IKuznetsov в 14:09, 26 декабря 2024

IKuznetsov в 09:18, 26 декабря 2024

ENetrebin: Новая страница: «Получает параметры указанной службы. Запрос создает application/jsonполезную нагрузку....»

ENetrebin: Новая страница: «Получает параметры указанной службы. Запрос создает `application/json`полезную нагрузку....»