GET объекты

Материал из Документация Ключ-АСТРОМ
Версия от 08:50, 20 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список объектов настроек, соответствующих заданным критериям. Запрос создает в качеств...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects
Среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/objects

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

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

Параметры

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

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

Чтобы загрузить все объекты, принадлежащие данным идентификаторам схемы, оставьте параметр scopes пустым.

query по желанию
scopes string Список разделенных запятыми областей, на которые нацелены запрошенные объекты.

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

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

Чтобы загрузить все объекты, принадлежащие заданным областям, оставьте параметр schemaIds пустым.

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

Укажите обязательные поля верхнего уровня через запятую (например, objectId,value).

query по желанию
nextPageKey string Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

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

Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса.

query по желанию
pageSize integer Количество объектов настроек в полезной нагрузке одного ответа.

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

Если не установлено, используется 100.

query по желанию

Ответ

Коды ответов

Код Тип Описание
200 ObjectsList Успех
403 ErrorEnvelope Не удалось. Запрещенный.
404 ErrorEnvelope Не удалось. Указанная схема или область не найдены.

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

Объект ObjectsList

Список объектов настроек.

Элемент Тип Описание
pageSize integer Количество записей на странице.
items SettingsObject[] Список объектов настроек.
nextPageKey string Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

totalCount integer Общее количество записей в результате.

Объект SettingsObject

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

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

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

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

modified integer Отметка времени последней модификации.
externalId string Внешний идентификатор объекта настроек.
author string Пользователь (идентифицируемый по идентификатору пользователя или общедоступному идентификатору токена), выполнивший последнее изменение.
schemaId string Схема, на которой основан объект.
objectId string Идентификатор объекта настроек.
created integer Отметка времени создания.
scope string Область, на которую нацелен объект.
summary string Кратко о настройках.
value SettingsValue Значение настройки.

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

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

Объект SettingsValue

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

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

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

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

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

{
  "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
}