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

Редактировать глобальную конфигурацию: различия между версиями

Материал из Документация АппОптима
Нет описания правки
Нет описания правки
 
(не показано 5 промежуточных версий 2 участников)
Строка 1: Строка 1:
Редактирует глобальную конфигурацию автообновления Environment ActiveGates.
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C%20%D0%BA%D0%BE%D0%B4-,%D0%90%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D0%B5%D0%A8%D0%BB%D1%8E%D0%B7%D1%8B,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C АктивныеШлюзы] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%9A%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F%20%D0%B0%D0%B2%D1%82%D0%BE%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F Конфигурация автообновления] / Редактировать глобальную конфигурацию'''''
 
Редактирует глобальную конфигурацию автообновления Environment АктивногоШлюза.


Запрос потребляет <code>application/json</code>полезную нагрузку.
Запрос потребляет <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
|СТАВИТЬ
|PUT
|
|
* Удалось https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / autoUpdate
* АппОптима https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / autoUpdate
* SaaS https: // {идентификатор-вашей-среды} .live.dynatrace.com / api / v2 / activeGates / autoUpdate
* Среда АктивногоШлюза https: // {ваш-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate
* Среда ActiveGate https: // {ваш-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate
|}
|}


== Аутентификация ==
== Аутентификация ==
Для выполнения этого запроса вам необходимо разрешение Write ActiveGates ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .


== Параметры ==
== Параметры ==
Строка 18: Строка 19:
!Тип
!Тип
!Описание
!Описание
!В
!In
!необходимые
!необходимость
|-
|-
|тело
|body
|Конфигурация глобального автоматического обновления Active Gate
|Конфигурация глобального автоматического обновления АктивногоШлюза
|Тело запроса в формате JSON, содержащее глобальные параметры автообновления.
|Тело запроса в формате JSON, содержащее глобальные параметры автообновления.
|тело
|body
|по желанию
|по желанию
|}
|}
Строка 33: Строка 34:


==== ActiveGateGlobalAutoUpdateConfig объект ====
==== ActiveGateGlobalAutoUpdateConfig объект ====
Глобальная конфигурация автообновления ActiveGates.
Глобальная конфигурация автообновления АктивныхШлюзов.
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
Строка 41: Строка 42:
|-
|-
|глобальные настройки
|глобальные настройки
|нить
|string
|Состояние автообновлений для всех ActiveGates, подключенных к среде или управляемому кластеру.
|Состояние автообновлений для всех АктивныхШлюзов, подключенных к среде или управляемому кластеру.


Этот параметр наследуется всеми ActiveGates, у которых есть этот <code>INHERITED</code>параметр.
Этот параметр наследуется всеми АктивныхШлюзов, у которых есть этот <code>INHERITED</code>параметр.


Элемент может содержать эти значения
Элемент может содержать эти значения


* ВКЛЮЧЕНО
* ВКЛЮЧЕНО
* ИНВАЛИД
* INVALID
|обязательный
|обязательный
|}
|}
Строка 56: Строка 57:


Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
  <code>{
  <{
   "globalSetting": "ENABLED",
   "globalSetting": "ENABLED",
   "metadata": {
   "metadata": {
Строка 69: Строка 70:
     ]
     ]
   }
   }
  }</code>
  }


== Ответ ==
== Ответ ==
Строка 95: Строка 96:
|POST
|POST
|
|
* Managed https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate / validator
* АппОптима https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate / validator
* Среда ActiveGate https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate / validator.
* Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate / validator.
|}
|}


=== Аутентификация ===
=== Аутентификация ===
Для выполнения этого запроса вам необходимо разрешение Write ActiveGates ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .
Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( <code>activeGates.write</code>), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .


=== Ответ ===
=== Ответ ===

Текущая версия от 14:07, 24 декабря 2024

API АппОптима / Эндпойнты среды / АктивныеШлюзы / Конфигурация автообновления / Редактировать глобальную конфигурацию

Редактирует глобальную конфигурацию автообновления Environment АктивногоШлюза.

Запрос потребляет application/jsonполезную нагрузку.

PUT
  • АппОптима https: // {ваш-домен} / e / {ваш-идентификатор-среды} / api / v2 / activeGates / autoUpdate
  • Среда АктивногоШлюза https: // {ваш-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate

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

Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

Параметры

Параметр Тип Описание In необходимость
body Конфигурация глобального автоматического обновления АктивногоШлюза Тело запроса в формате JSON, содержащее глобальные параметры автообновления. body по желанию

Формат тела

  • Параметры запроса

ActiveGateGlobalAutoUpdateConfig объект

Глобальная конфигурация автообновления АктивныхШлюзов.

Элемент Тип Описание необходимые
глобальные настройки string Состояние автообновлений для всех АктивныхШлюзов, подключенных к среде или управляемому кластеру.

Этот параметр наследуется всеми АктивныхШлюзов, у которых есть этот INHERITEDпараметр.

Элемент может содержать эти значения

  • ВКЛЮЧЕНО
  • INVALID
обязательный
  • Модель JSON

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "globalSetting": "ENABLED",
  "metadata": {
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ],
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ]
  }
}

Ответ

Коды ответов

Код Описание
204 Успех. Конфигурация глобального автообновления обновлена. У ответа нет тела.
400 Не удалось. Введены неверные данные.

Тело ответа

Успешный запрос не возвращает никакого содержания.

Проверить полезную нагрузку

Мы рекомендуем вам проверить полезную нагрузку, прежде чем отправлять ее с фактическим запросом. Код ответа 204 указывает на действительную полезную нагрузку.

Запрос потребляет application/jsonполезную нагрузку.

POST
  • АппОптима https: // {ваш-домен} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate / validator
  • Среда АктивногоШлюза https: // {your-activegate-domain} / e / {your-environment-id} / api / v2 / activeGates / autoUpdate / validator.

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

Для выполнения этого запроса вам необходимо разрешение Write АктивныеШлюзы ( activeGates.write), назначенное вашему токену API. Чтобы узнать, как его получить и использовать, см. Токены и аутентификация .

Ответ

Коды ответов

Код Описание
204 Подтверждено. Представленная конфигурация действительна. У ответа нет тела.
400 Не удалось. Введены неверные данные.

Тело ответа

Успешный запрос не возвращает никакого содержания.