ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
''''' | '''''Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Прокси для ВысокойДоступности / Тест конфигурации прокси из определенного центра обработки данных''''' | ||
Этот вызов API проверяет конфигурацию прокси из определенного центра обработки данных. | Этот вызов API проверяет конфигурацию прокси из определенного центра обработки данных. | ||
==Аутентификация== | ==Аутентификация== | ||
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. | Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера. | ||
==Конечная точка== | ==Конечная точка== | ||
<code>/api/v1.0/onpremise/proxy/test</code> | <code>/api/v1.0/onpremise/proxy/test</code> | ||
| Строка 68: | Строка 68: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"scheme": "http", | "scheme": "http", | ||
"server": "string", | "server": "string", | ||
| Строка 111: | Строка 111: | ||
|} | |} | ||
===JSON-модель тела ответа=== | ===JSON-модель тела ответа=== | ||
< | <{ | ||
"connectionOk": true, | "connectionOk": true, | ||
"testExecuted": true, | "testExecuted": true, | ||
| Строка 123: | Строка 123: | ||
<code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test/eu-west-1</nowiki></code> | <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test/eu-west-1</nowiki></code> | ||
====Тело ответа==== | ====Тело ответа==== | ||
< | <{ | ||
"connectionOk": true, | "connectionOk": true, | ||
"testExecuted": true, | "testExecuted": true, | ||
Версия от 13:22, 8 ноября 2024
Установка и настройка / Основные элементы АппОптима / АппОптима Managed / REST API / API Кластера v1 / Прокси для ВысокойДоступности / Тест конфигурации прокси из определенного центра обработки данных
Этот вызов API проверяет конфигурацию прокси из определенного центра обработки данных.
Аутентификация
Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.
Конечная точка
/api/v1.0/onpremise/proxy/test
Параметры
| Параметр | Тип | Описание | В | Обязательно |
|---|---|---|---|---|
| dc | string | Дата-центр | path | Да |
| body | InternetProxyChangeRequest | Конфигурация прокси-сервера для интернет-соединения | body | Да |
Объекты тела запроса
Объект InternetProxyChangeRequest
Настройка прокси-сервера для подключения к Интернету
| Элемент | Тип | Описание | Обязательно |
|---|---|---|---|
| scheme | string | Протокол, который использует прокси-сервер (http, https)
|
Да |
| server | string | Адрес (либо IP, либо имя хоста) прокси-сервера | Да |
| port | integer | Порт прокси-сервера | Да |
| user | string | Пользователь прокси-сервера, ноль означает, что предыдущее значение нельзя изменять. | Нет |
| password | string | Пароль прокси-сервера, ноль означает, что предыдущее значение нельзя изменять. | Нет |
| nonProxyHosts | string[] | Определение хостов, для которых прокси не будет использоваться. Вы можете определить несколько хостов. Каждый хост может начинаться или заканчиваться подстановочным знаком «*», например, для соответствия всему домену. | Нет |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"scheme": "http",
"server": "string",
"port": 1,
"user": "string",
"password": "string",
"nonProxyHosts": [
"string"
]
}
Ответ
Коды ответа
| Код | Тип | Описание |
|---|---|---|
| 200 | ConnectionStatus | Запрос обработан, подробности в тексте ответа |
Объекты тела ответа
Объект ConnectionStatus
Результат проверки интернет-соединения
| Элемент | Тип | Описание |
|---|---|---|
| connectionOk | boolean | Результат проверки соединения |
| testExecuted | boolean | Указывает, выполнялся ли тест |
| testExecutionMessage | string | Дополнительные комментарии обычно указывают, почему тест не был выполнен |
JSON-модель тела ответа
<{
"connectionOk": true,
"testExecuted": true,
"testExecutionMessage": "string"
}
Пример
В этом примере вы тестируете прокси-сервер (outbound-proxy-dc1.dynatrace.com), который использует порт 8080 и требует пароль в определенном центре обработки данных (eu-west-1), в то же время исключая внутренний тестовый хост ( *.internal.lab.company.com). В ответ вы получаете ответ JSON, указывающий, что соединение установлено.
Curl
curl -X PUT "https://myManaged.cluster.com/api/v1.0/onpremise/proxy/test/eu-west-1" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"scheme\":\"http\",\"server\":\"outbound-proxy-dc1.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/test/eu-west-1
Тело ответа
<{
"connectionOk": true,
"testExecuted": true,
"testExecutionMessage": "string"
}
Код ответа
200