Открыть поиск
Открыть меню
869
701
11
7 тыс.
Документация АппОптима
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

POST объект: различия между версиями

Материал из Документация АппОптима
Дополнительные действия
(Новая страница: «Создает новый объект настроек или проверяет предоставленный объект настроек. Запрос со...»)
 
Нет описания правки
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
'''''[[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=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%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=DELETE%20%D0%BE%D0%B4%D0%B8%D0%BD%20SLO-,%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8,-%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B Настройки] / [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%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B8-,%D0%9E%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B,-GET%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D1%8B Объекты] / POST объект'''''
Создает новый объект настроек или проверяет предоставленный объект настроек.
Создает новый объект настроек или проверяет предоставленный объект настроек.


Строка 4: Строка 6:
{| class="wikitable"
{| class="wikitable"
| rowspan="2" |POST
| rowspan="2" |POST
|Managed
|АппОптима
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects</nowiki></code>
|-
|-
Строка 102: Строка 104:
=== JSON-модель тела запроса ===
=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
  <code>[
  <[
   {
   {
     "schemaVersion": "1.0.0",
     "schemaVersion": "1.0.0",
Строка 113: Строка 115:
     }
     }
   }
   }
  ]</code>
  ]


== Ответ ==
== Ответ ==
Строка 239: Строка 241:


=== JSON-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>[
  <[
   {
   {
     "invalidValue": {
     "invalidValue": {
Строка 259: Строка 261:
     }
     }
   }
   }
  ]</code>
  ]

Текущая версия от 16:48, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Настройки / Объекты / POST объект

Создает новый объект настроек или проверяет предоставленный объект настроек.

Запрос создает и использует в качестве полезной нагрузки application/json формат.

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

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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write settings ( settings.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
validateOnly boolean Если true, запрос выполняет только проверку отправленных объектов настроек, не сохраняя их. query по желанию
body SettingsObjectCreate[] Тело JSON запроса. Содержит объекты настроек. body по желанию

Объекты тела запроса

Объект RequestBody

Объект не предоставляет никаких параметров.

Объект SettingsObjectCreate

Конфигурация нового объекта настроек.

Элемент Тип Описание Необходимость
schemaVersion string Версия схемы, на которой основан объект. по желанию
insertAfter string Положение нового объекта. Новый объект будет добавлен после указанного.

Если null, новый объект будет помещен в последнюю позицию.

Если указать пустую строку, новый объект будет помещен в первую позицию.

Применимо только к объектам, основанным на схемах с упорядоченными объектами ( параметру упорядоченияtrue схемы присвоено значение ).

по желанию
externalId string Внешний идентификатор создаваемого объекта по желанию
schemaId string Схема, на которой основан объект. требуется
scope string Область, на которую нацелен объект.

Если опущено при создании нового объекта и если схема поддерживает создание области, операция создаст область из предоставленного значения.

по желанию
value SettingsValue Значение настройки.

Он определяет фактические значения параметров настроек.

Фактическое содержимое зависит от схемы объекта.

требуется

Объект SettingsValue

Значение настройки.

Он определяет фактические значения параметров настроек.

Фактическое содержимое зависит от схемы объекта.

Объект не предоставляет никаких параметров.

JSON-модель тела запроса

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

<[
  {
    "schemaVersion": "1.0.0",
    "insertAfter": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "externalId": "string",
    "schemaId": "builtin:container.built-in-monitoring-rule",
    "scope": "HOST-D3A3C5A146830A79",
    "value": {
      "autoMonitoring": true
    }
  }
]

Ответ

Коды ответов

Код Тип Описание
200 SettingsObjectResponse[] Успех
207 SettingsObjectResponse Мультистатус: разные объекты полезной нагрузки имеют разные статусы.
400 SettingsObjectResponse Не удалось. Проверка схемы не удалась.
403 ErrorEnvelope Не удалось. Запрещенный.
404 SettingsObjectResponse Не удалось. Запрошенный ресурс не существует.
409 SettingsObjectResponse Не удалось. Конфликтный ресурс.

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

Объект ResponseBody

Объект не предоставляет никаких параметров.

Объект SettingsObjectResponse

Ответ на запрос на создание или обновление.

Элемент Тип Описание
invalidValue SettingsValue Значение настройки.

Он определяет фактические значения параметров настроек.

Фактическое содержимое зависит от схемы объекта.

objectId string При успешном запросе идентификатор созданного или измененного объекта настроек.
code integer Код состояния HTTP для объекта.
error Error -

Объект SettingsValue

Значение настройки.

Он определяет фактические значения параметров настроек.

Фактическое содержимое зависит от схемы объекта.

Объект не предоставляет никаких параметров.

Объект Error

Элемент Тип Описание
constraintViolations ConstraintViolation[] Список нарушений ограничений
code integer Код состояния HTTP
message string Сообщение об ошибке

Объект ConstraintViolation

Список нарушений ограничений

Элемент Тип Описание
parameterLocation string -

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

  • PATH
  • PAYLOAD_BODY
  • QUERY
location string -
message string -
path string -

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

<[
  {
    "invalidValue": {
      "autoMonitoring": true
    },
    "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
    "code": 1,
    "error": {
      "constraintViolations": [
        {
          "parameterLocation": "PATH",
          "location": "string",
          "message": "string",
          "path": "string"
        }
      ],
      "code": 1,
      "message": "string"
    }
  }
]
Источник — https://docs.expert-apm.ru/index.php?title=POST_объект&oldid=6243
Последнее изменение