GET объект*

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

Получает указанный объект настроек.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
objectId string Идентификатор требуемого объекта настроек. path требуется

Ответ

Коды ответов

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

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

Объект 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-модель тела ответа

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