GET эффективные значения

Материал из Документация Ключ-АСТРОМ

Перечисляет действующие значения параметров для указанных схем в указанной области .

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

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

GET Managed https://{your-domain}/e/{your-environment-id}/api/v2/settings/effectiveValues
Cреда АктивногоШлюза https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/effectiveValues

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

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

Параметры

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

Учитывается только при загрузке первой страницы, если nextPageKey не установлен.

query по желанию
scope string Область, на которую нацелены запрошенные объекты.

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

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

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

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

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

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

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

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

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

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

query по желанию

Ответ

Коды ответов

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

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

Объект EffectiveSettingsValuesList

Список действующих значений параметров.

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

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

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

Объект EffectiveSettingsValue

Действующее значение параметров.

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

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

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

Объект SettingsValue

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

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

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

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

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

{
  "pageSize": 1,
  "items": [
    {
      "schemaVersion": "1.0.0",
      "modified": 1,
      "externalId": "string",
      "author": "john.doe@example.com",
      "schemaId": "builtin:container.built-in-monitoring-rule",
      "origin": "HOST-D3A3C5A146830A79",
      "created": 1,
      "summary": "string",
      "value": {
        "autoMonitoring": true
      }
    }
  ],
  "nextPageKey": "AQAAABQBAAAABQ==",
  "totalCount": 1
}