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

2022-09-16T16:05:23Z

← Предыдущая		Версия 16:05, 16 сентября 2022
Строка 20:		Строка 20:
	===Объекты тела запроса===		===Объекты тела запроса===
	====Объект <code>InternetProxyChangeRequest</code>====		====Объект <code>InternetProxyChangeRequest</code>====
			Настройка прокси-сервера для подключения к Интернету
	{\| class="wikitable"		{\| class="wikitable"
	!Элемент		!Элемент

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

2022-09-16T16:03:12Z

Новая страница: «Этот вызов 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/configuration</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"
!Код
!Описание
|-
|'''201'''
|Успешно создана новая конфигурация
|-
|'''204'''
|Успешно, конфигурация обновлена
|-
|'''400'''
|Данная конфигурация прокси-сервера недействительна
|}
===JSON-модель тела ответа===
<code>{
"scheme": "http",
"server": "string",
"port": 1,
"user": "string",
"password": "string",
"nonProxyHosts": [
"string"
]
}</code>
==Пример==
В этом примере вы добавляете прокси-сервер <code>(outbound-proxy.dynatrace.com)</code>, который использует порт <code>8080</code> и требует пароль, в то же время исключая хост внутренней лаборатории <code>(*.internal.lab.company.com)</code>.
====Curl====
<code>curl -X PUT "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration</nowiki>" -H "accept: */*" -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/configuration</nowiki></code>
====Тело ответа====
<code>{
"code": 201,
"message": "Successful, new configuration created."
}</code>
====Код ответа====
<code>201</code>

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

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

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