ENetrebin: Новая страница: «Список всех синтетических мониторов в вашей среде. Список содержит только имена и идент...»

2022-10-21T15:42:48Z

Новая страница: «Список всех синтетических мониторов в вашей среде. Список содержит только имена и идент...»

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

Список всех синтетических мониторов в вашей среде. Список содержит только имена и идентификаторы мониторов. Для получения сведений используйте вызов GET a monitor .
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/monitors</nowiki></code>
|-
|Среда АктивногоШлюза
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/monitors</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|managementZone
|integer
|Отфильтровывает результирующий набор мониторов до тех, которые входят в указанную зону управления.

Здесь указывается идентификатор зоны управления.
|query
|по желанию
|-
|tag
|string[]
|Фильтрует результирующий набор мониторов по указанным тегам.

Вы можете указать несколько тегов в следующем формате: <code>tag=tag1&tag=tag2</code>. Монитор должен соответствовать всем указанным тегам.

В случае тегов «ключ-значение», таких как импортированные теги AWS или CloudFoundry, используйте следующий формат: <code>[context]key:value</code>.
|query
|по желанию
|-
|location
|string
|Отфильтровывает результирующий набор мониторов по тем, которые назначены указанному синтетическому местоположению.

Здесь указывается идентификатор локации.
|query
|по желанию
|-
|assignedApps
|string[]
|Отфильтровывает результирующий набор мониторов до тех, которые назначены указанным приложениям.

Вы можете указать несколько приложений в следующем формате: <code>assignedApps=app1&assignedApps=app2</code>. На монитор должны быть назначены все указанные приложения.

Здесь указывается идентификаторы объектов Ключ-АСТРОМ для приложений.
|query
|по желанию
|-
|type
|string
|Фильтрует результирующий набор мониторов до мониторов указанного типа: <code>BROWSER</code>или <code>HTTP</code>.
|query
|по желанию
|-
|enabled
|boolean
|Фильтрует результирующий набор мониторов на те, которые включены ( <code>true</code>) или отключены ( <code>false</code>).
|query
|по желанию
|-
|credentialId
|string
|Отфильтровывает результирующий набор мониторов, используя указанный набор учетных данных.

Здесь указывается идентификатор установленных здесь учетных данных.
|query
|по желанию
|-
|credentialOwner
|string
|Отфильтровывает результирующий набор мониторов, используя учетные данные, принадлежащие указанному пользователю.
|query
|по желанию
|}

== Ответ ==

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

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

==== Объект <code>Monitors</code> ====
Список синтетических мониторов
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|monitors
|MonitorCollectionElement[]
|Список синтетических мониторов.
|}

==== Объект <code>MonitorCollectionElement</code> ====
Краткое изображение синтетического монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|name
|string
|Имя синтетического объекта.
|-
|entityId
|string
|Идентификатор синтетического объекта.
|-
|type
|string
|Тип синтетического монитора.

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

* <code>BROWSER</code>
* <code>HTTP</code>
|-
|enabled
|boolean
|Состояние синтетического монитора.
|}

=== JSON-модель тела ответа ===
<code>{
"monitors": [
{
"name": "string",
"entityId": "string",
"type": "BROWSER",
"enabled": true
}
]
}</code>

== Пример ==
В этом примере в запросе перечислены все доступные мониторы среды mySampleEnv .

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

Результат усекается до первых трех записей.

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

==== URL-адрес запроса ====
<code><nowiki>https://mySampleEnv.live.ruscomtech.ru/api/v1/synthetic/monitors</nowiki></code>

==== Тело ответа ====
<code>{
"monitors": [
{
"name": "easyTravel Angular",
"entityId": "SYNTHETIC_TEST-000000000000C69F"
},
{
"name": "ruscomtech.ru",
"entityId": "SYNTHETIC_TEST-0000000000025434"
},
{
"name": "easytravel special offers",
"entityId": "SYNTHETIC_TEST-000000000000987A"
}
]
}</code>

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

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

ENetrebin: Новая страница: «Список всех синтетических мониторов в вашей среде. Список содержит только имена и идент...»