API синтетических нодов v2 — GET все ноды

API синтетических нодов v2 — Получить все ноды

Отображает список всех доступных для вашей среды синтетических нодов (и их параметров).

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

GET

https://{your-environment-id}.live.astromkey.com/api/v2/synthetic/nodes

GET Среда АктивныйШлюз Кластер АктивныйШлюз

https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/nodes

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

Для выполнения этого запроса вам потребуется токен доступа с областью действия syntheticLocations.read.

Чтобы узнать, как получить и использовать его, см. раздел «Токены и аутентификация».

Параметры

Параметр	Тип	Описание	В	Необходимый
assignedToLocation	string	Фильтрует полученный набор нодов, оставляя только те, которые назначены синтетическому местоположению, и те, которые не назначены. Допустимые значения: TRUE, FALSE.	запрос	Необязательный
isContainerized	boolean	Если установлено значение true, возвращаются только контейнеризированные ноды.	запрос	Необязательный

Ответ

Коды ответов

Код	Тип	Описание
200	Nodes	Успех
4XX	ErrorEnvelope	Ошибка на стороне клиента.
5XX	ErrorEnvelope	Ошибка на стороне сервера.

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

Объект Nodes

Список синтетических нодов

Элемент	Тип	Описание
nodes	NodeCollectionElement[]	Список синтетических нодов

Объект NodeCollectionElement

Краткое описание синтетического нода. Содержит только идентификатор и отображаемое имя.

Элемент	Тип	Описание
activeGateVersion	string	Версия АктивногоШлюза.
autoUpdateEnabled	boolean	АктивныйШлюз имеет включенную (true) или выключенную (false) опцию автоматического обновления.
browserMonitorsEnabled	boolean	Флаг «Включена проверка возможностей браузера».
capabilities	string[]	Список возможностей нода.
entityId	string	Идентификатор нода.
healthCheckStatus	string	Статус проверки работоспособности синтетического нода.
hostname	string	Имя хоста нода.
ips	string[]	IP-адрес нода.
oneAgentRoutingEnabled	boolean	АктивныйШлюз имеет включенную (true) или выключенную (false) маршрутизацию ЕдиногоАгента.
operatingSystem	string	Операционная система хоста АктивногоШлюза.
playerVersion	string	Версия синтетического проигрывателя.
status	string	Состояние синтетического нода.
version	string	Версия нода.

Объект ErrorEnvelope

Элемент	Тип	Описание
error	Error	–

Объект Error

Элемент	Тип	Описание
code	integer	Код состояния HTTP.
constraintViolations	ConstraintViolation[]	Список нарушений ограничений.
message	string	Сообщение об ошибке.

Объект ConstraintViolation

Список нарушений ограничений

Элемент	Тип	Описание
location	string	–
message	string	–
parameterLocation	string	Допустимые значения: HEADER, ...
path	string	–

Модели JSON тела ответа

{
  "nodes": [
    {
      "activeGateVersion": "1.172.2.20190607-040913",
      "autoUpdateEnabled": true,
      "browserMonitorsEnabled": true,
      "capabilities": [
        "HTTP_HIGH_RESOURCE",
        "HTTP"
      ],
      "entityId": "3086117876",
      "healthCheckStatus": "Ok",
      "hostname": "gdn.astromkey.trace",
      "ips": [
        "238.245.160.14"
      ],
      "oneAgentRoutingEnabled": true,
      "operatingSystem": "Linux",
      "playerVersion": "1.179.0.20190920-145430",
      "status": "Running",
      "version": "1.161.0.20181210-173639"
    }
  ]
}

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Пример

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

API-токен передается в заголовке Authorization.

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

cURL

curl -X GET \
  https://mySampleEnv.live.astromkey.com/api/v2/synthetic/nodes \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

URL запроса

https://mySampleEnv.live.astromkey.com/api/v2/synthetic/nodes

Тело ответа

{
  "nodes": [
    {
      "entityId": "3086117876",
      "hostname": "gdn.astromkey.trace",
      "ips": [
        "238.245.160.14"
      ],
      "version": "1.207.0.20201029-141904",
      "browserMonitorsEnabled": true,
      "activeGateVersion": "1.207.0.20201029-180431",
      "oneAgentRoutingEnabled": false,
      "operatingSystem": "Platform: Linux, Version: 4.4.0-1092-aws, Architecture: amd64, Processors: 2",
      "autoUpdateEnabled": true,
      "status": "Running",
      "playerVersion": "1.207.0.20201029-081128",
      "healthCheckStatus": "Ok"
    },
    {
      "entityId": "1267320067",
      "hostname": "244.94.30.253",
      "ips": [
        "244.94.30.253"
      ],
      "version": null,
      "browserMonitorsEnabled": true,
      "activeGateVersion": "1.207.0.20201029-180431",
      "oneAgentRoutingEnabled": false,
      "operatingSystem": "Platform: Linux, Version: 4.15.0-1057-azure, Architecture: amd64, Processors: 2",
      "autoUpdateEnabled": true,
      "status": null,
      "playerVersion": null,
      "healthCheckStatus": "Offline"
    }
  ]
}

Код ответа

200