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

Версия от 13:19, 8 ноября 2024

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

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

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

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

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

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

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответа

Код	Тип	Описание
200	InternetProxy	Success
404		Proxy is not configured

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

Объект `InternetProxy`

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

Элемент	Тип	Описание
scheme	string	Протокол, который использует прокси-сервер
server	string	Адрес (либо IP, либо имя хоста) прокси-сервера
port	integer	Порт прокси-сервера
nonProxyHosts	string[]	Хосты, для которых прокси не будет использоваться.
userOrPasswordDefined	boolean	Указывает, настроен ли пользователь/пароль для прокси

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

<{
  "scheme": "string",
  "server": "string",
  "port": 1,
  "nonProxyHosts": [
    "string"
  ],
  "userOrPasswordDefined": true
}

Пример

В этом примере вы запрашиваете конфигурацию прокси из Ключа-Астром Managed (myManaged.cluster.com). Вы получите ответ, указывающий прокси-сервер 172.16.115.211 на порту 8080, и что вам требуется пароль для использования этого прокси.

Curl

curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration" -H  "accept: application/json"

URL-адрес запроса

https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration

Тело ответа

<{
  "scheme": "http",
  "server": "172.16.115.211",
  "port": 8080,
  "userOrPasswordDefined": true
}

Код ответа

200

@@ Строка 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] / [[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 Прокси] / Получение конфигурации прокси кластера'''''
+'''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / 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>
@@ Строка 56: / Строка 56: @@
 ===JSON-модель тела ответа===
-  <code>{
+  <{
     "scheme": "string",
     "server": "string",
@@ Строка 72: / Строка 72: @@
   <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configuration</nowiki></code>
 ====Тело ответа====
-  <code>{
+  <{
     "scheme": "http",
     "server": "172.16.115.211",