Связаться с намиПодключиться

Метод putObjectRetention

Статья создана
Обновлена 15 августа 2025 г.

Устанавливает на версию объекта временную блокировку либо настраивает или снимает уже установленную блокировку.

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

Изменить установленную блокировку может только пользователь с ролью storage.admin. При изменении управляемой блокировки нужно использовать заголовок, подтверждающий обход блокировки (см. ниже). Строгую блокировку можно только продлить. Проверить блокировку можно с помощью метода getObjectRetention.

Подробнее о подготовке к работе с API и общем виде запроса см. в разделе Как пользоваться S3 API.

Запрос

PUT /{bucket}/{key}?retention&versionId={versionId} HTTP/2

Path-параметры

Параметр Описание
bucket Имя бакета.
key Ключ объекта.

Query-параметры

Параметр Описание
retention Обязательный параметр для обозначения типа операции.
versionId Идентификатор версии объекта. Обязательный параметр.

Заголовки

Используйте в запросе необходимые общие заголовки.

Также, если на версию объекта установлена временная управляемая блокировка (governance-mode retention), обязательно используйте заголовок, описанный ниже, чтобы обойти блокировку и подтвердить ее изменение.

Заголовок Описание
X-Amz-Bypass-Governance-Retention Заголовок, подтверждающий обход временной управляемой блокировки. Укажите значение true.

Схема данных

<ListBucketResult
          xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
          <KeyCount>1</KeyCount>
          <Name>my-sample-bucket</Name>
          <Prefix></Prefix>
          <MaxKeys>1000</MaxKeys>
          <IsTruncated>false</IsTruncated>
          <Contents>
              <Key>text.txt</Key>
              <LastModified>2025-05-15T07:23:08.030Z</LastModified>
              <Owner>
                  <ID>ajegtlf2q28a********</ID>
                  <DisplayName>ajegtlf2q28a********</DisplayName>
              </Owner>
              <ETag>&#34;f75a361db63aa4722fb8e083********&#34;</ETag>
              <Size>103</Size>
              <StorageClass>STANDARD</StorageClass>
              <TagSet></TagSet>
          </Contents>
      </ListBucketResult>
Элемент Описание
Retention

Корневой элемент с настройками блокировки.

Чтобы снять управляемую блокировку (если у вас есть роль storage.admin), оставьте элемент пустым.

Путь: Retention.
Mode

Тип блокировки:

  • GOVERNANCE — временная управляемая блокировка.
  • COMPLIANCE — временная строгая блокировка.

Путь: Retention\Mode.
RetainUntilDate

Дата и время окончания блокировки в формате RFC3339. Например, 2025-01-01T00:00:00. Конец блокировки указывается в часовом поясе UTC±00:00. Чтобы указать другой часовой пояс, добавьте к концу записи + или - и смещение от UTC±00:00.

Путь: Retention\RetainUntilDate.

Ответ

Заголовки

Ответ может содержать только общие заголовки.

Коды ответов

Перечень возможных ответов смотрите в разделе Ответы.

См. также

Предыдущая
selectObjectContent
Следующая
putObjectLegalHold