Habilita y usa la configuración de retención de objetos (original) (raw)

Ir al contenido principal

Habilita y usa la configuración de retención de objetos

Descripción general

En esta página, se describe cómo usar la función de bloqueo de retención de objetos, incluida la habilitación para un bucket y la configuración de retención de los objetos dentro del bucket.

Roles obligatorios

Para obtener los permisos que necesitas a fin de habilitar la función de bloqueo de retención de objetos para un bucket y establecer la configuración de retención en los objetos, pídele a tu administrador que te otorgue el rol de IAM Administrador de almacenamiento (roles/storage.admin) en el bucket o en el proyecto que contiene el bucket. Este rol predefinido contiene los permisos necesarios para establecer y administrar la configuración de retención. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

Permisos necesarios

También puedes obtener estos permisos con roles personalizados.

Para obtener más información sobre cómo otorgar roles en los buckets, consulta Configura y administra políticas de IAM en buckets. Para obtener información sobre cómo otorgar roles en proyectos, consulta Administra el acceso a los proyectos.

Habilita las retenciones de objetos para un bucket

Sigue estas instrucciones para permitir las configuraciones de retención de objetos en un bucket. Si deseas habilitar la configuración de retención de objetos para un bucket existente, debes seguir las instrucciones de la consola. Google Cloud

Console

Para habilitar la configuración de retención de objetos en un bucket nuevo, haz lo siguiente:

  1. Crea un bucket como lo harías normalmente y, en el paso Elige cómo proteger los datos de objetos, selecciona Retención (para el cumplimiento) y, a continuación, Habilitar la retención de objetos.

Para habilitar la configuración de retención de objetos en un bucket existente, haz lo siguiente:

  1. En la consola de Google Cloud , ve a la página Buckets de Cloud Storage.
    Ir a Buckets
  2. En la lista de buckets, haz clic en el nombre del bucket en el que deseas habilitar la retención de objetos.
  3. Selecciona la pestaña Protección cerca de la parte superior de la página.
    El estado de retención de objetos del bucket se muestra en la sección Retención de objetos.
  4. En la sección Retención de objetos, haz clic en No se habilitó la retención de objetos.
  5. En el diálogo que aparece, haga clic en Confirmar.

Línea de comandos

Crea un bucket como lo harías normalmente y, luego, incluye la marca --enable-per-object-retention en el comando.

Bibliotecas cliente

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C++.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

C#

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C#.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Java.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Node.js.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

PHP

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage PHP.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Python.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

API de REST

API de JSON

Crea un bucket como lo harías normalmente y, luego, incluye el parámetro de búsqueda enableObjectRetention=true como parte de la solicitud.

API de XML

Crea un bucket como lo harías normalmente y, luego, incluye el encabezado x-goog-bucket-object-lock-enabled: True como parte de la solicitud.

Ve el estado de retención de objetos de un bucket

Para ver si se pueden establecer configuraciones de retención para los objetos de un bucket, haz lo siguiente:

Console

  1. En la consola de Google Cloud , ve a la página Buckets de Cloud Storage.
    Ir a Buckets
  2. Haz clic en el nombre del bucket cuyo estado deseas verificar.
  3. Haz clic en la pestaña Protección.
  4. El estado de retención de objetos del bucket se muestra en la sección Retención de objetos.

Línea de comandos

Usa el comando gcloud storage buckets describe con la marca --format:

gcloud storage buckets describe gs://BUCKET_NAME --format="default(per_object_retention)"

En el ejemplo anterior, BUCKET_NAME es el nombre del bucket cuya política de retención deseas ver. Por ejemplo, my-bucket.

Si se realiza de forma correcta y existe una política de retención en el bucket, la respuesta será similar a la siguiente:

per_object_retention: mode: Enabled

Si se realiza de forma correcta y no existe una política de retención para el bucket, la respuesta será similar a la siguiente:

null

Bibliotecas cliente

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C++.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Si deseas ver la configuración de retención de objetos de un bucket, sigue las instrucciones para mostrar los metadatos de un bucket y busca el campo de retención de objetos en la respuesta.

C#

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C#.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Si deseas ver la configuración de retención de objetos de un bucket, sigue las instrucciones para mostrar los metadatos de un bucket y busca el campo de retención de objetos en la respuesta.

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Java.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Si deseas ver la configuración de retención de objetos de un bucket, sigue las instrucciones para mostrar los metadatos de un bucket y busca el campo de retención de objetos en la respuesta.

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Node.js.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Si deseas ver la configuración de retención de objetos de un bucket, sigue las instrucciones para mostrar los metadatos de un bucket y busca el campo de retención de objetos en la respuesta.

PHP

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage PHP.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Si deseas ver la configuración de retención de objetos de un bucket, sigue las instrucciones para mostrar los metadatos de un bucket y busca el campo de retención de objetos en la respuesta.

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Python.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Si deseas ver la configuración de retención de objetos de un bucket, sigue las instrucciones para mostrar los metadatos de un bucket y busca el campo de retención de objetos en la respuesta.

API de REST

API de JSON

  1. Tener la gcloud CLI instalada e inicializada, lo que te permite generar un token de acceso para el encabezado Authorization.
  2. Usa cURL para llamar a la API de JSON con una solicitud de bucket GET que incluya el campo objectRetention:
    curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME?fields=objectRetention"
    En el que BUCKET_NAME es el nombre del bucket correspondiente. Por ejemplo, my-bucket.

API de XML

  1. Tener la gcloud CLI instalada e inicializada, lo que te permite generar un token de acceso para el encabezado Authorization.
  2. Usa cURL para llamar a la API de XML con una solicitud de bucket GET con alcance ?object-lock:
    curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://storage.googleapis.com/BUCKET_NAME?object-lock"
    En el que BUCKET_NAME es el nombre del bucket correspondiente. Por ejemplo, my-bucket.

Establece la configuración de retención de un objeto

Si quieres establecer una configuración de retención para un objeto, este debe almacenarse en un bucket en el que las retenciones de objetos estén habilitadas. Para establecer una configuración de retención para un objeto, sigue estos pasos:

Console

  1. En la consola de Google Cloud , ve a la página Buckets de Cloud Storage.
    Ir a Buckets
  2. En la lista de buckets, haz clic en el nombre del bucket que contiene el objeto cuya configuración de retención deseas establecer o modificar.
    Se abrirá la página Detalles del bucket y se seleccionará la pestaña Objetos.
  3. Navega hasta el objeto, que puede estar en una carpeta.
  4. Haz clic en el nombre del objeto.
    Se abre la página Detalles del objeto, que muestra los metadatos de objetos.
  5. En la sección Protección, haz clic en el ícono Editar() asociado con Desde la configuración de retención de objetos.
    Se abrirá el panel Editar la retención.
  6. En la sección Configuración de retención de objetos, haz clic en Habilitadao Inhabilitada.
    1. Si la configuración de retención está habilitada, selecciona una fecha y hora para la configuración en la sección Período de retención y haz clic en Desbloqueada o Bloqueada en la sección Modo de retención.
  7. Haz clic en Confirmar.

Línea de comandos

Usa el comando gcloud storage objects update con las marcas adecuadas: Para agregar o modificar una configuración de retención, usa el siguiente comando. Ten en cuenta que debes incluir la marca --override-unlocked-retention si modificas una configuración existente de una manera que la bloquea o acorta su tiempo de retención:

gcloud storage objects update gs://BUCKET_NAME/OBJECT_NAME --retain-until=DATETIME --retention-mode=STATE

Aquí:

Si se realiza de forma correcta, la respuesta se verá como el ejemplo siguiente:

Updating gs://my-bucket/kitten.png... Completed 1

Para quitar una configuración de retención de un objeto, usa el siguiente comando:

gcloud storage objects update gs://BUCKET_NAME/OBJECT_NAME --clear-retention --override-unlocked-retention

Aquí:

Bibliotecas cliente

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C++.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

C#

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C#.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Java.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Node.js.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

PHP

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage PHP.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Python.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

API de REST

API de JSON

  1. Tener la gcloud CLI instalada e inicializada, lo que te permite generar un token de acceso para el encabezado Authorization.
  2. Crea un archivo JSON que contenga la siguiente información:
    {
    "retention": {
    "mode": STATE,
    "retainUntilTime": "DATETIME"
    }
    }
    Aquí:
    • STATE es Locked o Unlocked.
    • DATETIME es la fecha y hora más tempranas en las que se puede borrar el objeto. Por ejemplo, 2028-02-15T05:30:00Z.
  3. Usa cURL para llamar a la API de JSON con una solicitud de objeto PATCH:
    curl -X PATCH --data-binary @JSON_FILE_NAME \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME/o/OBJECT_NAME?overrideUnlockedRetention=BOOLEAN"
    Aquí:
    • JSON_FILE_NAME es la ruta de acceso del archivo que creaste en el paso 2.
    • BUCKET_NAME es el nombre del bucket correspondiente. Por ejemplo, my-bucket.
    • OBJECT_NAME es el nombre codificado en URL del objeto relevante. Por ejemplo, pets/kitten.png, codificado en URL como pets%2Fkitten.png.
    • BOOLEAN debe ser true si la solicitud se acorta, se quita o se bloquea una configuración de retención existente. De lo contrario, el parámetro overrideUnlockedRetention se puede excluir de la solicitud por completo.

API de XML

  1. Tener la gcloud CLI instalada e inicializada, lo que te permite generar un token de acceso para el encabezado Authorization.
  2. Crea un archivo XML que contenga la siguiente información: STATE DATETIME Aquí: * `STATE` es `GOVERNANCE` o `COMPLIANCE`. * `DATETIME` es la fecha y hora más tempranas en las que se puede borrar el objeto. Por ejemplo, `2028-02-15T05:30:00Z`.
  3. Usa cURL para llamar a la API de XML con una solicitud de objeto PUT con alcance ?retention:
    curl -X PUT --data-binary @XML_FILE_NAME \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "x-goog-bypass-governance-retention: BOOLEAN" \
    "https://storage.googleapis.com/BUCKET_NAME/OBJECT_NAME?retention"
    Aquí:
    • XML_FILE_NAME es la ruta de acceso del archivo XML que creaste en el paso 2.
    • BOOLEAN debe ser true si la solicitud se acorta, se quita o se bloquea una configuración de retención existente. De lo contrario, el encabezado x-goog-bypass-governance-retention se puede excluir de la solicitud por completo.
    • BUCKET_NAME es el nombre del bucket correspondiente. Por ejemplo, my-bucket.
    • OBJECT_NAME es el nombre codificado en URL del objeto relevante. Por ejemplo, pets/kitten.png, codificado en URL como pets%2Fkitten.png.

Ve la configuración de retención de un objeto

Para ver qué configuración de retención, si hay alguna, está establecida en un objeto, haz lo siguiente:

Console

  1. En la consola de Google Cloud , ve a la página Buckets de Cloud Storage.
    Ir a Buckets
  2. En la lista de buckets, haz clic en el nombre del bucket que contiene el objeto cuya configuración de retención deseas ver.
    Se abrirá la página Detalles del bucket y se seleccionará la pestaña Objetos.
  3. Navega hasta el objeto, que puede estar en una carpeta.
  4. Haz clic en el nombre del objeto.
    Se abre la página Detalles del objeto, que muestra los metadatos de objetos. En la sección Protección, se muestra información sobre las opciones de configuración de retención que tiene el objeto.

Línea de comandos

Usa el comando gcloud storage objects describe con la marca --format:

gcloud storage objects describe gs://BUCKET_NAME/OBJECT_NAME --format="default(retention_settings)"

Donde:

Si se ejecuta de forma correcta y existe una configuración de retención para el objeto, la respuesta es similar a la siguiente:

retention_settings: mode: Unlocked retainUntilTime: '2028-11-30T14:11:14+00:00'

Si se ejecuta de forma correcta y no existe una configuración de retención para el objeto, la respuesta es similar a la siguiente:

null

Bibliotecas cliente

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C++.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Para ver la configuración de retención de un objeto, sigue las instrucciones para mostrar los metadatos de un objeto y busca el campo de retención en la respuesta.

C#

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage C#.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Para ver la configuración de retención de un objeto, sigue las instrucciones para mostrar los metadatos de un objeto y busca el campo de retención en la respuesta.

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Java.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Para ver la configuración de retención de un objeto, sigue las instrucciones para mostrar los metadatos de un objeto y busca el campo de retención en la respuesta.

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Node.js.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Para ver la configuración de retención de un objeto, sigue las instrucciones para mostrar los metadatos de un objeto y busca el campo de retención en la respuesta.

PHP

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage PHP.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Para ver la configuración de retención de un objeto, sigue las instrucciones para mostrar los metadatos de un objeto y busca el campo de retención en la respuesta.

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Cloud Storage Python.

Para autenticarte en Cloud Storage, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para bibliotecas cliente.

Para ver la configuración de retención de un objeto, sigue las instrucciones para mostrar los metadatos de un objeto y busca el campo de retención en la respuesta.

API de REST

API de JSON

  1. Tener la gcloud CLI instalada e inicializada, lo que te permite generar un token de acceso para el encabezado Authorization.
  2. Usa cURL para llamar a la API de JSON con una solicitud de objeto GET que incluya el campo retention:
    curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://storage.googleapis.com/storage/v1/b/BUCKET_NAME/OBJECT_NAME?fields=retention"
    Aquí:
    • BUCKET_NAME es el nombre del bucket correspondiente. Por ejemplo, my-bucket.
    • OBJECT_NAME es el nombre del objeto pertinente. Por ejemplo, kitten.png.

API de XML

  1. Tener la gcloud CLI instalada e inicializada, lo que te permite generar un token de acceso para el encabezado Authorization.
  2. Usa cURL para llamar a la API de XML con una solicitud de objeto GET con alcance ?retention:
    curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://storage.googleapis.com/BUCKET_NAME/OBJECT_NAME?retention"
    Aquí:
    • BUCKET_NAME es el nombre del bucket correspondiente. Por ejemplo, my-bucket.
    • OBJECT_NAME es el nombre del objeto pertinente. Por ejemplo, kitten.png.

¿Qué sigue?

Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.

Última actualización: 2025-12-10 (UTC)