ENetrebin: Новая страница: «Список объектов настроек, соответствующих заданным критериям. Запрос создает в качеств...»

2022-10-20T08:50:58Z

Новая страница: «Список объектов настроек, соответствующих заданным критериям. Запрос создает в качеств...»

Новая страница

Список объектов настроек, соответствующих заданным критериям.

Запрос создает в качестве полезной нагрузки <code>application/json</code> формат.
{| class="wikitable"
| rowspan="2" |GET
|Managed
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects</nowiki></code>
|-
|Среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects</nowiki></code>
|}

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

== Параметры ==
{| class="wikitable"
!Параметр
!Тип
!Описание
!In
!Необходимость
|-
|schemaIds
|string
|Список идентификаторов схем, разделенных запятыми, которым принадлежат запрошенные объекты.

Для загрузки первой страницы, когда nextPageKey не установлен, требуется либо этот параметр, либо области действия.

Чтобы загрузить все объекты, принадлежащие данным идентификаторам схемы, оставьте параметр scopes пустым.
|query
|по желанию
|-
|scopes
|string
|Список разделенных запятыми областей, на которые нацелены запрошенные объекты.

Выбор соответствует только объектам, непосредственно нацеленным на указанные области. Например, <code>environment</code>не будут сопоставляться объекты, предназначенные для хоста в среде.

Для загрузки первой страницы, когда nextPageKey не установлен, требуется либо этот параметр, либо schemaIds .

Чтобы загрузить все объекты, принадлежащие заданным областям, оставьте параметр schemaIds пустым.
|query
|по желанию
|-
|fields
|string
|Список полей, которые должны быть включены в ответ. Предоставленный набор полей заменяет набор по умолчанию.

Укажите обязательные поля верхнего уровня через запятую (например, <code>objectId,value</code>).
|query
|по желанию
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.
|query
|по желанию
|-
|pageSize
|integer
|Количество объектов настроек в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.

Если не установлено, используется 100.
|query
|по желанию
|}

== Ответ ==

=== Коды ответов ===
{| class="wikitable"
!Код
|Тип
!Описание
|-
|200
|ObjectsList
|Успех
|-
|403
|ErrorEnvelope
|Не удалось. Запрещенный.
|-
|404
|ErrorEnvelope
|Не удалось. Указанная схема или область не найдены.
|}

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

==== Объект <code>ObjectsList</code> ====
Список объектов настроек.
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|pageSize
|integer
|Количество записей на странице.
|-
|items
|SettingsObject[]
|Список объектов настроек.
|-
|nextPageKey
|string
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
|-
|totalCount
|integer
|Общее количество записей в результате.
|}

==== Объект <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>{
"pageSize": 1,
"items": [
{
"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
}
}
],
"nextPageKey": "AQAAABQBAAAABQ==",
"totalCount": 1
}</code>

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

ENetrebin: Новая страница: «Список объектов настроек, соответствующих заданным критериям. Запрос создает в качеств...»