Тест конфигурации прокси кластера: различия между версиями
(Новая страница: «Этот вызов API проверяет конфигурацию прокси-сервера кластера. ==Аутентификация== Для выпо...») |
ENetrebin (обсуждение | вклад) |
||
(не показана 1 промежуточная версия 1 участника) | |||
Строка 1: | Строка 1: | ||
'''''[https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0 Установка и настройка] / [https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0#.D0.9E.D1.81.D0.BD.D0.BE.D0.B2.D0.BD.D1.8B.D0.B5_.D1.8D.D0.BB.D0.B5.D0.BC.D0.B5.D0.BD.D1.82.D1.8B_.D0.9A.D0.BB.D1.8E.D1.87-.D0.90.D1.81.D1.82.D1.80.D0.BE.D0.BC Основные элементы Ключ-Астром] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed Ключ-АСТРОМ Managed] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed#REST_API REST API] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1 API Кластера v1] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1#.D0.9F.D1.80.D0.BE.D0.BA.D1.81.D0.B8 Прокси] / Тест конфигурации прокси кластера''''' | |||
Этот вызов API проверяет конфигурацию прокси-сервера кластера. | Этот вызов API проверяет конфигурацию прокси-сервера кластера. | ||
==Аутентификация== | ==Аутентификация== | ||
Строка 57: | Строка 59: | ||
|Нет | |Нет | ||
|} | |} | ||
=== JSON-модель тела запроса === | |||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | |||
<code>{ | |||
"scheme": "http", | |||
"server": "string", | |||
"port": 1, | |||
"user": "string", | |||
"password": "string", | |||
"nonProxyHosts": [ | |||
"string" | |||
] | |||
}</code> | |||
==Ответ== | ==Ответ== | ||
===Коды ответа=== | ===Коды ответа=== |
Текущая версия на 13:54, 18 августа 2023
Установка и настройка / Основные элементы Ключ-Астром / Ключ-АСТРОМ Managed / 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://myManaged.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://myManaged.cluster.com/api/v1.0/onpremise/proxy/test
Тело ответа
{
"connectionOk": true,
"testExecuted": true,
"testExecutionMessage": "string"
}
Код ответа
200