RGolovanov в 16:30, 16 сентября 2022

2022-09-16T16:30:34Z

← Предыдущая		Версия 16:30, 16 сентября 2022
Строка 57:		Строка 57:
	\|Нет		\|Нет
	\|}		\|}

			=== JSON-модель тела запроса ===
			Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
			<code>{
			"scheme": "http",
			"server": "string",
			"port": 1,
			"user": "string",
			"password": "string",
			"nonProxyHosts": [
			"string"
			]
			}</code>

	==Ответ==		==Ответ==
	===Коды ответа===		===Коды ответа===

RGolovanov: Новая страница: «Этот вызов API проверяет конфигурацию прокси-сервера кластера. ==Аутентификация== Для выпо...»

2022-09-16T16:14:48Z

Новая страница: «Этот вызов API проверяет конфигурацию прокси-сервера кластера. ==Аутентификация== Для выпо...»

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

Этот вызов 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 Аутентификация кластера].
==Конечная точка==
<code>/api/v1.0/onpremise/proxy/test</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|body
|InternetProxyChangeRequest
|Конфигурация прокси-сервера для интернет-соединения
|body
|Да
|}
===Объекты тела запроса===
====Объект <code>InternetProxyChangeRequest</code>====
Настройка прокси-сервера для подключения к Интернету
{| class="wikitable"
!Элемент
!Тип
!Описание
!Обязательно
|-
|scheme
|string
|Протокол, который использует прокси-сервер (<code>http</code>, <code>https</code>)
|Да
|-
|server
|string
|Адрес (либо IP, либо имя хоста) прокси-сервера
|Да
|-
|port
|integer
|Порт прокси-сервера
|Да
|-
|user
|string
|Пользователь прокси-сервера, ноль означает, что предыдущее значение нельзя изменять.
|Нет
|-
|password
|string
|Пароль прокси-сервера, ноль означает, что предыдущее значение нельзя изменять.
|Нет
|-
|nonProxyHosts
|string[]
|Определение хостов, для которых прокси не будет использоваться. Вы можете определить несколько хостов. Каждый хост может начинаться или заканчиваться подстановочным знаком «*», например, для соответствия всему домену.
|Нет
|}
==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''200'''
|ConnectionStatus
|Запрос обработан, подробности в тексте ответа
|}

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

==== Объект <code>ConnectionStatus</code> ====
Результат проверки интернет-соединения
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|connectionOk
|boolean
|Результат проверки соединения
|-
|testExecuted
|boolean
|Указывает, выполнялся ли тест
|-
|testExecutionMessage
|string
|Дополнительные комментарии обычно указывают, почему тест не был выполнен
|}

===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>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test</nowiki></code>
====Тело ответа====
<code>{
"connectionOk": true,
"testExecuted": true,
"testExecutionMessage": "string"
}</code>
====Код ответа====
<code>200</code>

Тест конфигурации прокси кластера - История изменений

RGolovanov в 16:30, 16 сентября 2022

RGolovanov: Новая страница: «Этот вызов API проверяет конфигурацию прокси-сервера кластера. ==Аутентификация== Для выпо...»