Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

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

Материал из Документация АппОптима
Нет описания правки
Нет описания правки
 
(не показаны 2 промежуточные версии 2 участников)
Строка 1: Строка 1:
'''''Установка и настройка / Основные элементы АппОптима / АппОптима / REST API / API Кластера v1 / Прокси для ВысокойДоступности / Получение конфигурации прокси для всех центров обработки данных'''''
Этот вызов API возвращает конфигурации прокси-сервера для всех центров обработки данных в высокодоступных развертываниях.
Этот вызов 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/configurations</code>
<code>/api/v1.0/onpremise/proxy/configurations</code>
Строка 63: Строка 65:
|}
|}
===JSON-модель тела ответа===
===JSON-модель тела ответа===
  <code>{
  <{
   "scheme": "string",
   "scheme": "string",
   "server": "string",
   "server": "string",
Строка 71: Строка 73:
   ],
   ],
   "userOrPasswordDefined": true
   "userOrPasswordDefined": true
  }</code>
  }
==Пример==
==Пример==
В этом примере вы запрашиваете получение конфигураций прокси для всех центров обработки данных. В ответ вы получите список ответов JSON с конфигурациями прокси для <code>eu-west-1</code> и <code>us-east-1</code>.
В этом примере вы запрашиваете получение конфигураций прокси для всех центров обработки данных. В ответ вы получите список ответов JSON с конфигурациями прокси для <code>eu-west-1</code> и <code>us-east-1</code>.
====Curl====
====Curl====
  <code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configurations</nowiki>" -H  "accept: application/json"</code>
  <code>curl -X GET "<nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configurations</nowiki>" -H  "accept: application/json"</code>
====URL-адрес запроса====
====URL-адрес запроса====
  <code><nowiki>https://myManaged.cluster.com/api/v1.0/onpremise/proxy/configurations</nowiki></code>
  <code><nowiki>https://myАппОптима.cluster.com/api/v1.0/onpremise/proxy/configurations</nowiki></code>
====Тело ответа====
====Тело ответа====
  <code>{
  <{
   "configurations": {
   "configurations": {
     "eu-west-1": {
     "eu-west-1": {
Строка 101: Строка 103:
     }
     }
   }
   }
  }</code>
  }
====Код ответа====
====Код ответа====
<code>200</code>
<code>200</code>

Текущая версия от 20:51, 25 декабря 2024

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

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

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

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

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

/api/v1.0/onpremise/proxy/configurations

Параметры

Параметр Тип Описание В Обязательно
dc string Дата-центры path Да

Ответ

Коды ответа

Код Тип Описание
200 InternetProxy Успех
404 Прокси не настроен

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

Объект InternetProxy

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

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

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

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

Пример

В этом примере вы запрашиваете получение конфигураций прокси для всех центров обработки данных. В ответ вы получите список ответов JSON с конфигурациями прокси для eu-west-1 и us-east-1.

Curl

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

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

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

Тело ответа

<{
  "configurations": {
    "eu-west-1": {
      "scheme": "http",
      "server": "outbound-proxy-dc1.dynatrace.com",
      "port": 8080,
      "nonProxyHosts": [
        "https://mycompany.com/proxy/*",
        "*.internal.lab.company.com"
      ],
      "userOrPasswordDefined": true
    },
    "us-east-1": {
      "scheme": "http",
      "server": "outbound-proxy-dc2.dynatrace.com",
      "port": 8080,
      "nonProxyHosts": [
        ""
      ],
      "userOrPasswordDefined": true
    }
  }
}

Код ответа

200