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

Текущая версия от 21:04, 25 декабря 2024

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

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

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

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

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

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

Параметры

Параметр	Тип	Описание	В	Обязательно
dc	string	Дата-центр	path	Да
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-dc1.dynatrace.com), который использует порт 8080 и требует пароль в определенном центре обработки данных (eu-west-1), в то же время исключая внутренний тестовый хост ( *.internal.lab.company.com). В ответ вы получаете ответ JSON, указывающий, что соединение установлено.

Curl

curl -X PUT "https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/test/eu-west-1" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy-dc1.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/eu-west-1

Тело ответа

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

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Прокси для ВысокойДоступности / Тест конфигурации прокси из определенного центра обработки данных'''''
+'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Прокси для ВысокойДоступности / Тест конфигурации прокси из определенного центра обработки данных'''''
 Этот вызов API проверяет конфигурацию прокси из определенного центра обработки данных.
@@ Строка 77: / Строка 77: @@
       "string"
     ]
-  }</code>
+  }
 ==Ответ==
@@ Строка 115: / Строка 115: @@
     "testExecuted": true,
     "testExecutionMessage": "string"
-  }</code>
+  }
 ==Пример==
 В этом примере вы тестируете прокси-сервер <code>(outbound-proxy-dc1.dynatrace.com)</code>, который использует порт <code>8080</code> и требует пароль в определенном центре обработки данных <code>(eu-west-1)</code>, в то же время исключая внутренний тестовый хост <code>( *.internal.lab.company.com)</code>. В ответ вы получаете ответ JSON, указывающий, что соединение установлено.
 ====Curl====
-  <code>curl -X PUT "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test/eu-west-1</nowiki>" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy-dc1.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/eu-west-1</nowiki>" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy-dc1.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/eu-west-1</nowiki></code>
+  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/test/eu-west-1</nowiki></code>
 ====Тело ответа====
   <{
@@ Строка 127: / Строка 127: @@
     "testExecuted": true,
     "testExecutionMessage": "string"
-  }</code>
+  }
 ====Код ответа====
 <code>200</code>