ENetrebin: Новая страница: «Получает указанный объект настроек. Запрос создает в качестве полезной нагрузки `applic...»`


2022-10-20T09:04:19Z
Новая страница: «Получает указанный объект настроек.  Запрос создает в качестве полезной нагрузки <code>applic...»
Новая страница
Получает указанный объект настроек.



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

{| class="wikitable"

| rowspan="2" |GET

|Managed

|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>

|-

|Cреда АктивногоШлюза

|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}</nowiki></code>

|}



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

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Чтение настроек ( <code>settings.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .



== Параметры ==

{| class="wikitable"

!Параметр

!Тип

!Описание

!In

!Необходимость

|-

|objectId

|string

|Идентификатор требуемого объекта настроек.

|path

|требуется

|}



== Ответ ==



=== Коды ответов ===

{| class="wikitable"

!Код

|Тип

!Описание

|-

|200

|SettingsObject

|Успех

|-

|403

|ErrorEnvelope

|Не удалось. Запрещенный.

|-

|404

|ErrorEnvelope

|Нет доступного объекта для данного objectId

|}



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



==== Объект <code>SettingsObject</code> ====

Объект настроек.

{| class="wikitable"

!Элемент

!Тип

!Описание

|-

|schemaVersion

|string

|Версия схемы, на которой основан объект.

|-

|updateToken

|string

|Токен обновления объекта. Вы можете использовать его для обнаружения одновременных изменений разными пользователями.



Генерируется при извлечении (запросы GET). Если установлено при обновлении (запрос PUT) или удалении, обновление/удаление будет разрешено только в том случае, если не было никаких изменений между получением и обновлением.



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

|-

|modified

|integer

|Отметка времени последней модификации.

|-

|externalId

|string

|Внешний идентификатор объекта настроек.

|-

|author

|string

|Пользователь (идентифицируемый по идентификатору пользователя или общедоступному идентификатору токена), выполнивший последнее изменение.

|-

|schemaId

|string

|Схема, на которой основан объект.

|-

|objectId

|string

|Идентификатор объекта настроек.

|-

|created

|integer

|Отметка времени создания.

|-

|scope

|string

|Область, на которую нацелен объект.

|-

|summary

|string

|Кратко о настройках.

|-

|value

|SettingsValue

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



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



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

|}



==== Объект <code>SettingsValue</code> ====

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



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



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



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



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

 <code>{

   "schemaVersion": "1.0.0",

   "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",

   "modified": 1,

   "externalId": "string",

   "author": "john.doe@example.com",

   "schemaId": "builtin:container.built-in-monitoring-rule",

   "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",

   "created": 1,

   "scope": "HOST-D3A3C5A146830A79",

   "summary": "string",

   "value": {

     "autoMonitoring": true

   }

 }</code>

GET объект* - История изменений

ENetrebin: Новая страница: «Получает указанный объект настроек. Запрос создает в качестве полезной нагрузки applic...»

ENetrebin: Новая страница: «Получает указанный объект настроек. Запрос создает в качестве полезной нагрузки `applic...»`