Нет описания правки |
Нет описания правки |
||
Строка 1: | Строка 1: | ||
'''''Установка и настройка / Основные элементы АппОптима / АппОптима | '''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Прокси / Получение конфигурации прокси кластера''''' | ||
Этот вызов API возвращает конфигурацию прокси-сервера кластера. | Этот вызов API возвращает конфигурацию прокси-сервера кластера. | ||
Строка 64: | Строка 64: | ||
], | ], | ||
"userOrPasswordDefined": true | "userOrPasswordDefined": true | ||
} | } | ||
==Пример== | ==Пример== | ||
В этом примере вы запрашиваете конфигурацию прокси из Ключа-Астром | В этом примере вы запрашиваете конфигурацию прокси из Ключа-Астром АппОптима <code>(myАппОптима.cluster.com)</code>. Вы получите ответ, указывающий прокси-сервер <code>172.16.115.211</code> на порту <code>8080</code>, и что вам требуется пароль для использования этого прокси. | ||
====Curl==== | ====Curl==== | ||
<code>curl -X GET "<nowiki>https:// | <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configuration</nowiki>" -H "accept: application/json"</code> | ||
====URL-адрес запроса==== | ====URL-адрес запроса==== | ||
<code><nowiki>https:// | <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configuration</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
<{ | <{ | ||
Строка 77: | Строка 77: | ||
"port": 8080, | "port": 8080, | ||
"userOrPasswordDefined": true | "userOrPasswordDefined": true | ||
} | } | ||
====Код ответа==== | ====Код ответа==== | ||
<code>200</code> | <code>200</code> |
Текущая версия от 11:47, 25 декабря 2024
Установка и настройка / Основные элементы АппОптима / АппОптима / 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