Nesta página, veja como listar os objetos armazenados nos buckets do Cloud Storage, que são ordenados na lista de maneira lexicográfica pelo nome.
Antes de começar
Para receber as permissões necessárias para listar objetos, peça ao administrador
que conceda a você o papel do IAM de Leitor de objetos do Storage (roles/storage.objectViewer
)
para o bucket que contém os objetos que você quer
listar. Se você quiser listar objetos em pastas gerenciadas, conceda
roles/storage.objectViewer
na pasta gerenciada que contém os objetos
que você quer visualizar em vez do bucket.
Se você planeja usar o console Trusted Cloud para realizar as tarefas desta página,
peça ao administrador para conceder a você o papel básico de Leitor (roles/viewer
), além do papel de Leitor de objetos do Storage (roles/storage.objectViewer
).
Esses papéis contêm as permissões necessárias para listar objetos. Para ver as permissões exatas necessárias, expanda a seção Permissões necessárias:
Permissões necessárias
storage.objects.list
storage.buckets.list
- Essa permissão só será necessária se você quiser usar o Trusted Cloud console para executar as tarefas nesta página.
Também é possível conseguir essas permissões com outros papéis predefinidos ou personalizados.
Para informações sobre como conceder papéis para buckets, consulte Usar o IAM com buckets.
Listar os objetos em um bucket
Console
- No console Trusted Cloud , acesse a página Buckets do Cloud Storage.
Na lista de buckets, clique no nome do bucket cujo conteúdo você quer visualizar.
Linha de comando
Use o comando gcloud storage ls
:
gcloud storage ls gs://BUCKET_NAME
Em que:
BUCKET_NAME
é o nome do bucket que contém os objetos que você quer listar. Por exemplo,my-bucket
.
Bibliotecas de cliente
C++
Para mais informações, consulte a documentação de referência da API Cloud Storage C++.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
C#
Saiba mais na documentação de referência C# da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
Go
Saiba mais na documentação de referência Go da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
Java
Saiba mais na documentação de referência Java da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
Node.js
Saiba mais na documentação de referência Node.js da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
PHP
Saiba mais na documentação de referência PHP da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
Python
Saiba mais na documentação de referência Python da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
Ruby
Saiba mais na documentação de referência Ruby da API Cloud Storage.
Para se autenticar no Cloud Storage, configure o Application Default Credentials. Saiba mais em Configurar a autenticação para bibliotecas de cliente.
Antes de executar exemplos de código, defina a variável de ambiente GOOGLE_CLOUD_UNIVERSE_DOMAIN
como s3nsapis.fr
.
A amostra a seguir lista todos os objetos de um bucket:
A amostra a seguir lista os objetos com um prefixo determinado:
APIs REST
API JSON
Ter CLI gcloud instalada e inicializada, o que permite gerar um token de acesso para o cabeçalho
Authorization
.Use
cURL
para chamar a API JSON com uma solicitação para listar objetos:curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://storage.s3nsapis.fr/storage/v1/b/BUCKET_NAME/o"
Em que
BUCKET_NAME
é o nome do bucket com os objetos que você quer listar. Por exemplo,my-bucket
.
API XML
Ter CLI gcloud instalada e inicializada, o que permite gerar um token de acesso para o cabeçalho
Authorization
.Use
cURL
para chamar a API XML com uma solicitação de bucketGET
:curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://storage.s3nsapis.fr/BUCKET_NAME?list-type=2"
Em que
BUCKET_NAME
é o nome do bucket com os objetos que você quer listar. Por exemplo,my-bucket
.É possível usar um parâmetro de string de consulta
prefix=PREFIX
para limitar os resultados a objetos que tenham o prefixo especificado.
Listar os objetos em uma pasta
Console
- No console Trusted Cloud , acesse a página Buckets do Cloud Storage.
Na lista de buckets, clique no nome do bucket que contém a pasta.
Na guia Objetos da página Detalhes do bucket, clique no nome da pasta cujo conteúdo você quer visualizar.
Linha de comando
Use o comando gcloud storage ls
para listar os objetos em uma pasta:
gcloud storage ls gs://BUCKET_NAME/FOLDER_NAME
Em que:
BUCKET_NAME
é o nome do bucket que contém a pasta. Por exemplo,my-bucket
.FOLDER_NAME
é o nome da pasta que contém os objetos que você quer listar. Por exemplo,my-folder
.
APIs REST
API JSON
Para listar os objetos em uma pasta, use uma solicitação de listagem de objetos com os parâmetros prefix
e delimiter
. Quando o parâmetro prefix
é definido, a operação de lista é limitada para retornar apenas objetos e pastas no prefixo. Quando o parâmetro delimiter
é definido, a lista prefixes[]
na resposta é preenchida com os nomes das pastas no prefixo especificado.
Exemplo:
Para listar todos os objetos na pasta
image/
no bucketmy-bucket
, use o seguinte URL:"https://storage.s3nsapis.fr/storage/v1/b/my-bucket/o?prefix=image&delimiter=/"
.Isso pode retornar os objetos
my-bucket/image/cat.jpeg
emy-bucket/image/dog.jpeg
.Para incluir objetos em subpastas dentro de
image/
, remova o parâmetrodelimiter
:"https://storage.s3nsapis.fr/storage/v1/b/my-bucket/o?prefix=image"
.Isso pode retornar os objetos
my-bucket/image/cat.jpeg
,my-bucket/image/dog.jpeg
emy-bucket/image/dog/shiba.jpeg
.
Para usar caracteres curinga na solicitação de listagem de objetos e corresponder objetos por
expressão glob, use o parâmetro matchGlob
. Por exemplo, matchGlob=**.jpeg
corresponde a todos os
objetos que terminam em .jpeg
. Ao usar matchGlob
, defina
delimiter
como /
.
Por exemplo, use o seguinte URL para corresponder a todos os objetos na
pasta image
que terminam em .jpeg
:
"https://storage.s3nsapis.fr/storage/v1/b/my-bucket/o?prefix=image&delimiter=/&matchGlob=**.jpeg"
Para mais detalhes sobre como usar parâmetros para filtrar objetos, consulte a documentação de referência da API JSON com relação à lista de objetos.
Caso de uso
O uso de prefix
para listar o conteúdo de uma pasta pode ser útil quando
você só tem permissão para listar objetos nela, não
no bucket inteiro. Por exemplo, digamos que você tenha o papel do IAM de Leitor de objetos do Storage
(roles/storage.objectViewer
) para a pasta gerenciada my-bucket/my-managed-folder-a/
, mas
não para a pasta gerenciada my-bucket/my-managed-folder-b/
. Para retornar
apenas os objetos em my-managed-folder-a
, especifique
prefix=my-managed-folder-a/
.
Como filtrar objetos
Ao listar objetos, é possível usar prefixos ou sufixos na solicitação de lista para filtrar objetos por nome.
Console
Consulte filtragem e classificação para saber como filtrar e classificar objetos em buckets ou pastas.
Linha de comando
É possível usar caracteres curinga no comando gcloud storage ls
para
filtrar objetos por prefixo ou sufixo. Por exemplo, o comando a seguir
lista apenas os objetos no bucket my-bucket
cujo nome começa com
image
e termina com .png
:
gcloud storage ls gs://my-bucket/image*.png
Se a solicitação for bem-sucedida, a resposta será semelhante a esta:
gs://my-bucket/image.png gs://my-bucket/image-dog.png gs://my-bucket/image-cat.png ...
É possível usar caracteres curinga de estrela dupla para corresponder a zero ou mais níveis de pasta em um caminho. Por exemplo, o comando a seguir lista apenas objetos cujo nome
termina em .jpeg
em qualquer pasta ou subpasta no bucket my-bucket
:
gcloud storage ls gs://my-bucket/**/*.jpeg
Se a solicitação for bem-sucedida, a resposta será semelhante a esta:
gs://my-bucket/puppy.jpeg gs://my-bucket/pug.jpeg gs://my-bucket/pets/dog.jpeg ...
APIs REST
Consulte listar objetos em pastas para saber como filtrar objetos por pasta ou prefixo de nome de objeto.
Considerações sobre desempenho ao listar objetos
A estrutura subjacente dos buckets com namespace hierárquico ativado influencia o desempenho da operação de listagem de objetos, quando comparada a buckets de namespace simples. Para mais informações, consulte Otimizar o desempenho em buckets com namespace hierárquico ativado.
A seguir
- Faça o download de um objeto do seu bucket.
- Visualize e edite metadados de objetos.
- Exclua objetos do bucket.
- Saiba como paginar resultados.