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

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

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

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

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

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

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

/api/v1.0/onpremise/proxy/configuration

Параметры

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

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

Объект `InternetProxyChangeRequest`

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

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

Ответ

Коды ответа

Код	Описание
201	Успешно создана новая конфигурация
204	Успешно, конфигурация обновлена
400	Данная конфигурация прокси-сервера недействительна

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

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

Пример

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

Curl

curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration" -H  "accept: */*" -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/configuration

Тело ответа

<{
  "code": 201,
  "message": "Successful, new configuration created."
}

Код ответа

201

@@ Строка 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/configuration</code>
@@ Строка 20: / Строка 22: @@
 ===Объекты тела запроса===
 ====Объект <code>InternetProxyChangeRequest</code>====
+Настройка прокси-сервера для подключения к Интернету
 {| class="wikitable"
 !Элемент
@@ Строка 72: / Строка 75: @@
 |}
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "scheme": "http",
     "server": "string",
@@ Строка 81: / Строка 84: @@
       "string"
     ]
-  }</code>
+  }
 ==Пример==
 В этом примере вы добавляете прокси-сервер <code>(outbound-proxy.dynatrace.com)</code>, который использует порт <code>8080</code> и требует пароль, в то же время исключая хост внутренней лаборатории <code>(*.internal.lab.company.com)</code>.
@@ Строка 89: / Строка 92: @@
   <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>