восстановить-объект
Описание
Примечание
Данная операция не поддерживается для ведер с каталогами.Восстанавливает архивную копию объекта в Amazon S3
Эта функция не поддерживается для Amazon S3 на Outposts.
Этот action выполняет следующие типы запросов:
-
restore an archive- Восстановление архивного объекта
Для получения дополнительной информации о структуре S3 в теле запроса, см. следующие разделы:
-
PutObject
-
Управление доступом с помощью ACL в руководстве Amazon S3 User Guide
-
Защита данных с помощью шифрования на стороне сервера в руководстве Amazon S3 User Guide
Разрешения
Для использования этой операции необходимо иметь разрешения на выполнение действия s3:RestoreObject. Владелец ведра по умолчанию имеет это разрешение и может предоставить его другим. Для получения дополнительной информации о разрешениях, см. Разрешения, связанные с операциями с подресурсами ведра, и Управление разрешениями доступа к вашим ресурсам Amazon S3 в руководстве Amazon S3 User Guide.
Объекты, которые вы архивируете в хранилище S3 Glacier Flexible Retrieval или S3 Glacier Deep Archive, а также в уровнях хранения S3 Intelligent-Tiering Archive или S3 Intelligent-Tiering Deep Archive, недоступны в реальном времени. Для объектов в хранилищах S3 Glacier Flexible Retrieval или S3 Glacier Deep Archive сначала необходимо выполнить запрос на восстановление, а затем дождаться, пока временная копия объекта станет доступной. Если вам нужна постоянная копия объекта, создайте её копию в хранилище Amazon S3 Standard в вашем ведре S3. Чтобы получить доступ к архивным объектам, вы должны восстановить объект на указанный период (количество дней). Для объектов в уровнях доступа Archive Access или Deep Archive Access в S3 Intelligent-Tiering, необходимо сначала выполнить запрос на восстановление, а затем дождаться перемещения объекта в уровень Frequent Access.
Для восстановления конкретной версии объекта вы можете указать идентификатор версии. Если вы не укажете идентификатор версии, Amazon S3 восстановит текущую версию.
При восстановлении архивного объекта вы можете указать один из следующих вариантов уровня доступа к данным в элементе Tier тела запроса:
-
Expedited- Ускоренное извлечение позволяет быстро получить доступ к вашим данным, хранящимся в хранилище S3 Glacier Flexible Retrieval или уровне хранения S3 Intelligent-Tiering Archive, когда требуется периодическое неотложное восстановление архивов. Для всех, за исключением самых больших архивных объектов (более 250 МБ+), данные, полученные с помощью ускоренного извлечения, обычно становятся доступными в течение 1–5 минут. Гарантированная емкость обеспечивает наличие емкости для извлечения с использованием ускоренного метода, когда это необходимо. Ускоренное извлечение и гарантированная емкость недоступны для объектов, хранящихся в хранилище S3 Glacier Deep Archive или уровне хранилища S3 Intelligent-Tiering Deep Archive. -
Standard- Стандартное извлечение позволяет получить доступ к любым вашим архивным объектам в течение нескольких часов. Это параметр по умолчанию для запросов извлечения, которые не указывают параметр извлечения. Стандартное извлечение обычно завершается в течение 3–5 часов для объектов, хранящихся в хранилище S3 Glacier Flexible Retrieval или уровне хранения S3 Intelligent-Tiering Archive. Оно обычно завершается в течение 12 часов для объектов, хранящихся в хранилище S3 Glacier Deep Archive или уровне хранения S3 Intelligent-Tiering Deep Archive. Стандартное извлечение бесплатное для объектов, хранящихся в S3 Intelligent-Tiering. -
Bulk- Массовое извлечение, бесплатное для объектов, хранящихся в хранилищах S3 Glacier Flexible Retrieval и S3 Intelligent-Tiering, позволяет извлекать большие объёмы данных, даже петабайты, без дополнительной платы. Массовое извлечение обычно завершается в течение 5–12 часов для объектов, хранящихся в хранилище S3 Glacier Flexible Retrieval или уровне хранения S3 Intelligent-Tiering Archive. Массовое извлечение также является самым выгодным вариантом извлечения при восстановлении объектов из S3 Glacier Deep Archive. Обычно оно завершается в течение 48 часов для объектов, хранящихся в хранилище S3 Glacier Deep Archive или уровне хранения S3 Intelligent-Tiering Deep Archive.
Дополнительную информацию о параметрах извлечения архивов и гарантированной емкости для доступа к данным Expedited см. в руководстве Amazon S3 User Guide - Восстановление архивных объектов.
Вы можете использовать повышение скорости восстановления Amazon S3, чтобы изменить скорость восстановления на более высокую, пока процесс не завершен. Дополнительную информацию см. в руководстве Amazon S3 User Guide - Повышение скорости текущего восстановления.
Чтобы получить состояние восстановления объекта, вы можете отправить запрос HEAD. Операции возвращают заголовок x-amz-restore, который предоставляет информацию о статусе восстановления в ответе. Вы можете использовать уведомления Amazon S3 об событиях для получения уведомлений при инициации или завершении восстановления. Дополнительную информацию см. в руководстве Amazon S3 User Guide - Настройка уведомлений Amazon S3 об событиях.
После восстановления архивного объекта вы можете обновить срок восстановления, повторно выпустив запрос с новым периодом. Amazon S3 обновляет срок восстановления относительно текущего времени и взимает плату только за запрос — платы за передачу данных нет. Вы не можете обновить срок восстановления, когда Amazon S3 активно обрабатывает ваш текущий запрос на восстановление объекта.
Если ваше ведро имеет конфигурацию жизненного цикла с правилом, которое включает действие истечения срока действия, истечение срока действия объекта перекрывает срок, который вы указали в запросе на восстановление. Например, если вы восстанавливаете копию объекта на 10 дней, но истечение срока действия объекта запланировано на 3 дня, Amazon S3 удаляет объект через 3 дня. Дополнительную информацию о конфигурации жизненного цикла см. в руководстве Amazon S3 User Guide - PutBucketLifecycleConfiguration и Управление жизненным циклом объектов.
Успешная операция возвращает код состояния 200 OK или 202 Accepted.
- Если объект ранее не восстанавливался, Amazon S3 возвращает
202 Acceptedв ответе. - Если объект был ранее восстановлен, Amazon S3 возвращает
200 OKв ответе. - Специальные ошибки:
- Код: RestoreAlreadyInProgress
- Причина: Восстановление объекта уже в процессе.
- Код HTTP-статуса: 409 Конфликт
- Префикс кода ошибки SOAP: Client
-
- Код: GlacierExpeditedRetrievalNotAvailable
- Причина: Ускоренное извлечение в настоящее время недоступно. Повторите попытку позже. (Возвращается, если емкости недостаточно для обработки запроса Expedited. Эта ошибка применима только к ускоренному извлечению, а не к S3 Standard или массовому извлечению.)
- Код HTTP-статуса: 503
- Префикс кода ошибки SOAP: N/A
Следующие операции связаны с RestoreObject :
- PutBucketLifecycleConfiguration
- GetBucketNotificationConfiguration
См. также: Документация AWS API
Синтаксис
restore-object
--bucket <value>
--key <value>
[--version-id <value>]
[--restore-request <value>]
[--request-payer <value>]
[--checksum-algorithm <value>]
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--bucket (строка)
Имя ведра, содержащего объект для восстановления.
Точки доступа — при использовании этого действия с точкой доступа для ведер общего назначения необходимо указать псевдоним точки доступа вместо имени ведра или указать ARN точки доступа. При использовании этого действия с точкой доступа для ведер каталога необходимо указать имя точки доступа вместо имени ведра. При использовании ARN точки доступа необходимо направлять запросы на хост-имя точки доступа. Хост-имя точки доступа имеет вид ИмяТочкиДоступа -ИдентификаторАккаунта .s3-accesspoint.*Регион* .amazonaws.com. При использовании этого действия с точкой доступа через SDK Amazon Web Services необходимо указать ARN точки доступа вместо имени ведра. Дополнительную информацию о значениях ARN точек доступа см. в руководстве пользователя Amazon S3.
S3 на Outposts — при использовании этого действия с S3 на Outposts необходимо направлять запросы на хост-имя S3 на Outposts. Хост-имя S3 на Outposts имеет вид `` ИмяТочкиДоступа -ИдентификаторАккаунта .*IDOutpost* .s3-outposts.*Регион* .amazonaws.com``. При использовании этого действия с S3 на Outposts целевое ведро должно иметь ARN точки доступа Outposts или псевдоним точки доступа. Дополнительную информацию о S3 на Outposts см. в руководстве пользователя Amazon S3.
--key (строка)
--version-id (строка)
--restore-request (структура)
Контейнер для параметров задания восстановления.
Days -> (целое число)
Срок действия активной копии в днях. Не использовать с восстановлениями, которые указывают OutputLocation .
Элемент Days требуется для обычных восстановлений и не должен предоставляться для выборочных запросов.
GlacierJobParameters -> (структура)
Параметры S3 Glacier, относящиеся к этому заданию. Не использовать с восстановлениями, которые указывают OutputLocation .
Tier -> (строка)
Type -> (строка)
Предупреждение
Amazon S3 Select больше недоступен для новых клиентов. Существующие клиенты Amazon S3 Select могут продолжать использовать функцию как обычно. ПодробнееТип запроса на восстановление.
Tier -> (строка)
Description -> (строка)
SelectParameters -> (структура)
Предупреждение
Amazon S3 Select больше недоступен для новых клиентов. Существующие клиенты Amazon S3 Select могут продолжать использовать функцию как обычно. ПодробнееОписание параметров для типов заданий Select.
InputSerialization -> (структура)
Описание формата сериализации объекта.
CSV -> (структура)
Описание сериализации объекта в формате CSV.
FileHeaderInfo -> (строка)
Описание первой строки ввода. Допустимые значения:
-
NONE: Первая строка не является заголовком. -
IGNORE: Первая строка является заголовком, но вы не можете использовать значения заголовка для указания столбца в выражении. Вы можете использовать позицию столбца (например, _1, _2, …) для указания столбца (SELECT s._1 FROM OBJECT s). -
Use: Первая строка является заголовком, и вы можете использовать значение заголовка для идентификации столбца в выражении (SELECT "name" FROM OBJECT).
Comments -> (строка)
Символ, используемый для указания, что строка должна быть пропущена, если этот символ находится в начале строки. Можно указать любой символ для обозначения строки комментария. По умолчанию используется # .
По умолчанию: #
QuoteEscapeCharacter -> (строка)
""" a , b """ разбирается как " a , b ".RecordDelimiter -> (строка)
FieldDelimiter -> (строка)
QuoteCharacter -> (строка)
Один символ, используемый для экранирования, когда разделитель полей является частью значения. Например, если значение — a, b, Amazon S3 помещает это значение поля в кавычки следующим образом: " a , b ".
Тип: Строка
По умолчанию: "
Предки: CSV
AllowQuotedRecordDelimiter -> (булево)
CompressionType -> (строка)
JSON -> (структура)
Указывает JSON как формат сериализации входных данных объекта.
Type -> (строка)
Parquet -> (структура)
ExpressionType -> (строка)
Expression -> (строка)
Предупреждение
Amazon S3 Select больше недоступен для новых клиентов. Существующие клиенты Amazon S3 Select могут продолжать использовать функцию как обычно. ПодробнееВыражение, используемое для запроса объекта.
OutputSerialization -> (структура)
Описание способа сериализации результатов задания Select.
CSV -> (структура)
Описание сериализации результатов Select в формате CSV.
QuoteFields -> (строка)
Указывает, использовать ли кавычки вокруг выходных полей.
-
ALWAYS: Всегда использовать кавычки для выходных полей. -
ASNEEDED: Использовать кавычки для выходных полей при необходимости.
QuoteEscapeCharacter -> (строка)
RecordDelimiter -> (строка)
FieldDelimiter -> (строка)
QuoteCharacter -> (строка)
a, b, Amazon S3 помещает это значение поля в кавычки следующим образом: " a , b ".JSON -> (структура)
Указывает JSON как формат сериализации выходных данных запроса.
RecordDelimiter -> (строка)
OutputLocation -> (структура)
Описание расположения, где хранятся выходные данные задания восстановления.
S3 -> (структура)
Описание расположения S3, которое получит результаты запроса восстановления.
BucketName -> (строка)
Prefix -> (строка)
Encryption -> (структура)
Содержит тип шифрования, используемого на стороне сервера.
EncryptionType -> (строка)
aws:kms).KMSKeyId -> (строка)
aws:kms, это необязательное значение указывает ID симметричного управляемого пользователем ключа KMS, который нужно использовать для шифрования результатов задания. Amazon S3 поддерживает только симметричные ключи KMS. Дополнительную информацию см. в руководстве разработчика Amazon Web Services Key Management Service.KMSContext -> (строка)
aws:kms, это необязательное значение можно использовать для указания контекста шифрования для результатов восстановления.CannedACL -> (строка)
AccessControlList -> (список)
Список разрешений, контролирующих доступ к подготовленным результатам.
(структура)
Контейнер для информации о разрешении.
Grantee -> (структура)
Человек, которому предоставляются разрешения.
DisplayName -> (строка)
EmailAddress -> (строка)
Электронный адрес получателя.
Примечание
Использование адресов электронной почты для указания получателя поддерживается только в следующих регионах Amazon Web Services:
- US East (N. Virginia)
- US West (N. California)
- US West (Oregon)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- Europe (Ireland)
- South America (São Paulo)
Список всех поддерживаемых Amazon S3 регионов и конечных точек см. в документе Amazon Web Services General Reference.
ID -> (строка)
Type -> (строка)
URI -> (строка)
Permission -> (строка)
Tagging -> (структура)
Набор тегов, применяемых к результатам восстановления.
TagSet -> (список)
Коллекция набора тегов
(структура)
Контейнер пары имя-значение тега.
Key -> (строка)
Value -> (строка)
UserMetadata -> (список)
Список метаданных для хранения с результатами восстановления в S3.
(структура)
Пара метаданных ключ-значение для хранения с объектом.
Name -> (строка)
Value -> (строка)
StorageClass -> (строка)
Синтаксис JSON:
{
"Days": integer,
"GlacierJobParameters": {
"Tier": "Standard"|"Bulk"|"Expedited"
},
"Type": "SELECT",
"Tier": "Standard"|"Bulk"|"Expedited",
"Description": "string",
"SelectParameters": {
"InputSerialization": {
"CSV": {
"FileHeaderInfo": "USE"|"IGNORE"|"NONE",
"Comments": "string",
"QuoteEscapeCharacter": "string",
"RecordDelimiter": "string",
"FieldDelimiter": "string",
"QuoteCharacter": "string",
"AllowQuotedRecordDelimiter": true|false
},
"CompressionType": "NONE"|"GZIP"|"BZIP2",
"JSON": {
"Type": "DOCUMENT"|"LINES"
},
"Parquet": {
}
},
"ExpressionType": "SQL",
"Expression": "string",
"OutputSerialization": {
"CSV": {
"QuoteFields": "ALWAYS"|"ASNEEDED",
"QuoteEscapeCharacter": "string",
"RecordDelimiter": "string",
"FieldDelimiter": "string",
"QuoteCharacter": "string"
},
"JSON": {
"RecordDelimiter": "string"
}
}
},
"OutputLocation": {
"S3": {
"BucketName": "string",
"Prefix": "string",
"Encryption": {
"EncryptionType": "AES256"|"aws:kms"|"aws:kms:dsse",
"KMSKeyId": "string",
"KMSContext": "string"
},
"CannedACL": "private"|"public-read"|"public-read-write"|"authenticated-read"|"aws-exec-read"|"bucket-owner-read"|"bucket-owner-full-control",
"AccessControlList": [
{
"Grantee": {
"DisplayName": "string",
"EmailAddress": "string",
"ID": "string",
"Type": "CanonicalUser"|"AmazonCustomerByEmail"|"Group",
"URI": "string"
},
"Permission": "FULL_CONTROL"|"WRITE"|"WRITE_ACP"|"READ"|"READ_ACP"
}
...
],
"Tagging": {
"TagSet": [
{
"Key": "string",
"Value": "string"
}
...
]
},
"UserMetadata": [
{
"Name": "string",
"Value": "string"
}
...
],
"StorageClass": "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE"|"OUTPOSTS"|"GLACIER_IR"|"SNOW"|"EXPRESS_ONEZONE"
}
}
}
--request-payer (строка)
Подтверждает, что запросчик понимает, что с него будет взиматься плата за запрос. Владельцам ведра не нужно указывать этот параметр в своих запросах. Если в источнике или целевом S3-ведре включена опция Requester Pays, то запросчик заплатит за соответствующие расходы на копирование объекта. Дополнительную информацию о загрузке объектов из ведер с Requester Pays см. в руководстве Amazon S3 User Guide в разделе Загрузка объектов из ведер с Requester Pays.
Примечание
Данная функция не поддерживается для ведер с каталогами.Возможные значения:
requester
--checksum-algorithm (строка)
Указывает алгоритм, используемый для создания контрольной суммы объекта при использовании SDK. Этот заголовок не предоставит никаких дополнительных функций, если вы не используете SDK. При отправке этого заголовка должен быть отправлен соответствующий заголовок x-amz-checksum или x-amz-trailer. В противном случае Amazon S3 отклонит запрос с кодом HTTP-статуса 400 Bad Request. Дополнительную информацию см. в руководстве Amazon S3 User Guide в разделе Проверка целостности объекта.
Если вы предоставите отдельную контрольную сумму, Amazon S3 проигнорирует любой предоставленный параметр ChecksumAlgorithm.
Возможные значения:
CRC32CRC32CSHA1SHA256CRC64NVME
--expected-bucket-owner (строка)
403 Forbidden (доступ запрещен).--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. При указании значения output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включить отладку.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- вкл
- выкл
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с сертификатом CA, используемый для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве AWS CLI User Guide.
Если не указано иное, все примеры имеют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. раздел Использование кавычек со строками в руководстве AWS CLI User Guide.
Для создания запроса восстановления объекта
Следующий пример restore-object восстанавливает указанный Amazon S3 Glacier-объект для ведра my-glacier-bucket на 10 дней.
aws s3api restore-object \
--bucket my-glacier-bucket \
--key doc1.rtf \
--restore-request Days=10
Эта команда не выводит никаких данных.
Вывод
RequestCharged -> (строка)
Если присутствует, указывает, что запросчик успешно оплатил за запрос.
Примечание
Данная функция не поддерживается для ведер с каталогами.RestoreOutputPath -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.