View a markdown version of this page

ListBucket (API de SOAP) - Amazon Simple Storage Service
SolicitudesRespuesta de éxitoCuerpo de respuestaControl de acceso

ListBucket (API de SOAP)

nota

Las API de SOAP para Amazon S3 no están disponibles para nuevos clientes y se acercan al fin de la vida útil (EOL) el 31 de agosto de 2025. Le recomendamos que utilice la API de REST o los SDK de AWS.

La operación ListBucket devuelve información sobre alguno de los elementos en el bucket.

Para obtener una introducción general a la operación de muestra, consulte Listado de claves de objetos.

Solicitudes

En este ejemplo, se muestran hasta 1000 claves del bucket “quotes” que tienen el prefijo “notas”.

Sintaxis

<ListBucket xmlns="https://doc.s3.amazonaws.com/2006-03-01">
  <Bucket>quotes</Bucket>
  <Prefix>notes/</Prefix>
  <Delimiter>/</Delimiter>
  <MaxKeys>1000</MaxKeys>
  <AWSAccessKeyId>AKIAIOSFODNN7EXAMPLE</AWSAccessKeyId>
  <Timestamp>2006-03-01T12:00:00.183Z</Timestamp>
  <Signature>Iuyz3d3P0aTou39dzbqaEXAMPLE=</Signature>
</ListBucket>

Parámetros

Nombre Descripción Obligatorio
prefix

Limita la respuesta a las claves que comienzan con el prefijo indicado. Puede usar prefijos para separar un bucket en diferentes conjuntos de claves de forma similar a como un sistema de archivos usa las carpetas.

Tipo: cadena

Valor predeterminado: None

 No
marker

Indica en qué parte del bucket se debe empezar a mostrar. La lista solo incluirá las claves que aparecen lexicográficamente después del marcador. Esto resulta práctico para la paginación: para pasar a la siguiente página de resultados, utilice la última clave de la página actual como marcador.

Tipo: cadena

Valor predeterminado: None

 No
max-keys

El número máximo de claves que le gustaría ver en el cuerpo de la respuesta. Es posible que el servidor devuelva menos claves que esta cantidad, pero no devolverá más.

Tipo: cadena

Valor predeterminado: None

 No
delimiter

Hace que las claves que contienen la misma cadena entre el prefijo y la primera aparición del delimitador se agrupen en un único elemento de resultado de la colección CommonPrefixes. Estas claves acumuladas no se devuelven en ninguna otra parte de la respuesta.

Tipo: cadena

Valor predeterminado: None

 No

Respuesta de éxito

Esta respuesta asume que el bucket contiene las siguientes claves:

notes/todos.txt
notes/2005-05-23/customer_mtg_notes.txt
notes/2005-05-23/phone_notes.txt
notes/2005-05-28/sales_notes.txt

Sintaxis

<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Name>backups</Name>
  <Prefix>notes/</Prefix>
  <MaxKeys>1000</MaxKeys>
  <Delimiter>/</Delimiter>
  <IsTruncated>false</IsTruncated>
  <Contents>
    <Key>notes/todos.txt</Key>
    <LastModified>2006-01-01T12:00:00.000Z</LastModified>
    <ETag>&quot;828ef3fdfa96f00ad9f27c383fc9ac7f&quot;</ETag>
    <Size>5126</Size>
    <StorageClass>STANDARD</StorageClass>
    <Owner>
      <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>
      <DisplayName>webfile</DisplayName>
    </Owner>
    <StorageClass>STANDARD</StorageClass>
  </Contents>
  <CommonPrefixes>
    <Prefix>notes/2005-05-23/</Prefix>
  </CommonPrefixes>
  <CommonPrefixes>
    <Prefix>notes/2005-05-28/</Prefix>
  </CommonPrefixes>
  </ListBucketResult>

Como puede ver, muchos de los campos de la respuesta reflejan los parámetros de solicitud. IsTruncated, Contents y CommonPrefixes son los únicos elementos de respuesta que pueden contener información nueva.

Elementos de respuesta

Nombre Descripción
Contents

Metadatos sobre cada objeto devuelto.

Tipo: Metadatos XML

Antecesor: ListBucketResult
CommonPrefixes

Una respuesta puede contener CommonPrefixes solo si se especifica un delimiter. Si lo hace, CommonPrefixes contiene todas las claves (si las hay) situadas entre Prefix y la siguiente aparición de la cadena especificada por delimiter. En efecto, CommonPrefixes muestra las claves que actúan como subdirectorios en el directorio especificado por Prefix. Por ejemplo, si prefix es notes/ y delimiter es una barra diagonal (/), en notes/summer/july, el prefijo común es notes/summer/.

Tipo: cadena

Antecesor: ListBucketResult
Delimiter

Hace que las claves que contienen la misma cadena entre el prefijo y la primera aparición del delimitador se agrupen en un único elemento de resultado de la colección CommonPrefixes. Estas claves acumuladas no se devuelven en ninguna otra parte de la respuesta.

Tipo: cadena

Antecesor: ListBucketResult
IsTruncated

Especifica si se devolvieron todos los resultados (verdadero) o no (falso). Es posible que no se devuelvan todos los resultados si el número de resultados supera el especificado por MaxKeys.

Tipo: cadena

Antecesor: boolean
Marker

Indica en qué parte del bucket se debe empezar a mostrar.

Tipo: cadena

Antecesor: ListBucketResult
MaxKeys

El número máximo de claves devueltas en el cuerpo de respuesta.

Tipo: cadena

Antecesor: ListBucketResult
Name

Nombre del bucket.

Tipo: cadena

Antecesor: ListBucketResult
Prefix

Claves que comienzan con el prefijo indicado.

Tipo: cadena

Antecesor: ListBucketResult

Cuerpo de respuesta

Para obtener información sobre la respuesta de la lista, consulte Lista de respuesta de claves.

Control de acceso

Para mostrar las claves de un bucket, es necesario que se haya concedido acceso de READ al bucket.