Тест конфигурации прокси кластера: различия между версиями

Текущая версия от 15:50, 6 января 2025

Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Прокси / Тест конфигурации прокси кластера

Этот вызов API проверяет конфигурацию прокси-сервера кластера.

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

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/v1.0/onpremise/proxy/test

Параметры

Параметр	Тип	Описание	В	Обязательно
body	InternetProxyChangeRequest	Конфигурация прокси-сервера для интернет-соединения	body	Да

Объекты тела запроса

Объект `InternetProxyChangeRequest`

Настройка прокси-сервера для подключения к Интернету

Элемент	Тип	Описание	Обязательно
scheme	string	Протокол, который использует прокси-сервер (`http`, `https`)	Да
server	string	Адрес (либо IP, либо имя хоста) прокси-сервера	Да
port	integer	Порт прокси-сервера	Да
user	string	Пользователь прокси-сервера, ноль означает, что предыдущее значение нельзя изменять.	Нет
password	string	Пароль прокси-сервера, ноль означает, что предыдущее значение нельзя изменять.	Нет
nonProxyHosts	string[]	Определение хостов, для которых прокси не будет использоваться. Вы можете определить несколько хостов. Каждый хост может начинаться или заканчиваться подстановочным знаком «*», например, для соответствия всему домену.	Нет

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "scheme": "http",
  "server": "string",
  "port": 1,
  "user": "string",
  "password": "string",
  "nonProxyHosts": [
    "string"
  ]
}

Ответ

Коды ответа

Код	Тип	Описание
200	ConnectionStatus	Запрос обработан, подробности в тексте ответа

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

Объект `ConnectionStatus`

Результат проверки интернет-соединения

Элемент	Тип	Описание
connectionOk	boolean	Результат проверки соединения
testExecuted	boolean	Указывает, выполнялся ли тест
testExecutionMessage	string	Дополнительные комментарии обычно указывают, почему тест не был выполнен

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

<{
  "connectionOk": true,
  "testExecuted": true,
  "testExecutionMessage": "string"
}

Пример

В этом примере вы тестируете прокси-сервер (outbound-proxy.dynatrace.com), который использует порт 8080 и требует пароль, в то же время исключая внутренний тестовый хост (*.internal.lab.company.com). В ответ вы получаете ответ JSON, указывающий, что соединение установлено.

Curl

curl -X PUT "https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/test" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy.dynatrace.com\",\"port\":8080,\"nonProxyHosts\":[\"https://mycompany.com/proxy/*\",\"*.internal.lab.company.com\"],\"userOrPasswordDefined\":true}"

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

https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/test

Тело ответа

<{
  "connectionOk": true,
  "testExecuted": true,
  "testExecutionMessage": "string"
}

Код ответа

200

@@ Строка 1: / Строка 1: @@
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v1]] / [[API Кластера v1|Прокси]] / Тест конфигурации прокси кластера'''''
 Этот вызов API проверяет конфигурацию прокси-сервера кластера.
 ==Аутентификация==
-Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
+Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
 ==Конечная точка==
 <code>/api/v1.0/onpremise/proxy/test</code>
@@ Строка 57: / Строка 59: @@
 |Нет
 |}
+=== JSON-модель тела запроса ===
+Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
+ <{
+   "scheme": "http",
+   "server": "string",
+   "port": 1,
+   "user": "string",
+   "password": "string",
+   "nonProxyHosts": [
+     "string"
+   ]
+ }
 ==Ответ==
 ===Коды ответа===
@@ Строка 92: / Строка 108: @@
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "connectionOk": true,
     "testExecuted": true,
     "testExecutionMessage": "string"
-  }</code>
+  }
 ==Пример==
 В этом примере вы тестируете прокси-сервер <code>(outbound-proxy.dynatrace.com)</code>, который использует порт <code>8080</code> и требует пароль, в то же время исключая внутренний тестовый хост <code>(*.internal.lab.company.com)</code>. В ответ вы получаете ответ JSON, указывающий, что соединение установлено.
 ====Curl====
-  <code>curl -X PUT "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test</nowiki>" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy.dynatrace.com\",\"port\":8080,\"nonProxyHosts\":[\"<nowiki>https://mycompany.com/proxy/*</nowiki>\",\"*.internal.lab.company.com\"],\"userOrPasswordDefined\":true}"</code>
+  <code>curl -X PUT "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/test</nowiki>" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy.dynatrace.com\",\"port\":8080,\"nonProxyHosts\":[\"<nowiki>https://mycompany.com/proxy/*</nowiki>\",\"*.internal.lab.company.com\"],\"userOrPasswordDefined\":true}"</code>
 ====URL-адрес запроса====
-  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/test</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "connectionOk": true,
     "testExecuted": true,
     "testExecutionMessage": "string"
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>