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

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

Установка и настройка / Основные элементы АппОптима / АппОптима / 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
}

Пример

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

Curl

curl -X GET "https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configuration" -H  "accept: application/json"

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

https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configuration

Тело ответа

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

Код ответа

200

@@ Строка 1: / Строка 1: @@
-'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Прокси / Получение конфигурации прокси кластера'''''
+'''''[[Установка и настройка]] / [[Установка и настройка|Основные элементы АппОптима]] / [[АппОптима]] / [[АппОптима|REST API]] / [[API Кластера v1]] / [[API Кластера v1|Прокси]] / Получение конфигурации прокси кластера'''''
 Этот вызов API возвращает конфигурацию прокси-сервера кластера.
@@ Строка 66: / Строка 66: @@
   }
 ==Пример==
-В этом примере вы запрашиваете конфигурацию прокси из Ключа-Астром АппОптима <code>(myАппОптима.cluster.com)</code>. Вы получите ответ, указывающий прокси-сервер <code>172.16.115.211</code> на порту <code>8080</code>, и что вам требуется пароль для использования этого прокси.
+В этом примере вы запрашиваете конфигурацию прокси из АппОптима <code>(myАппОптима.cluster.com)</code>. Вы получите ответ, указывающий прокси-сервер <code>172.16.115.211</code> на порту <code>8080</code>, и что вам требуется пароль для использования этого прокси.
 ====Curl====
   <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configuration</nowiki>" -H  "accept: application/json"</code>