ListBuckets (GetService) - List all buckets | OSS API - Object Storage Service: Central de Documentação do Alibaba Cloud

Notas de uso

Para listar buckets do Object Storage Service (OSS), é necessária a permissão oss:ListBuckets.

Para mais informações, consulte Conceder uma política personalizada.

Sintaxe da solicitação

GET / HTTP/1.1
Host: oss.example.com
Date: GMT Date
Authorization: SignatureValue

Cabeçalhos da solicitação

Cabeçalho

Tipo

Obrigatório

Exemplo

Descrição

x-oss-resource-group-id

String

Não

rg-aek27tc****

ID do grupo de recursos.

Se definido como um ID de grupo de recursos, retorna os buckets desse grupo.

Se definido como rg-default-id, retorna os buckets do grupo de recursos padrão.
Se incluído sem valor, retorna os buckets do grupo de recursos padrão.
Se omitido, retorna todos os buckets da sua conta Alibaba Cloud.

Obtenha o ID do grupo de recursos no console Resource Management ou chamando ListResourceGroups. Para mais informações, consulte Visualizar um grupo de recursos e ListResourceGroups.

Para obter detalhes sobre outros cabeçalhos comuns de solicitação incluídos em uma requisição ListBuckets (GetService), como Host e Date, consulte Cabeçalhos comuns de solicitação.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
prefix	String	Não	my	Prefixo obrigatório nos nomes dos buckets retornados. Sem esse parâmetro, o sistema não filtra os buckets por prefixo. Padrão: vazio.
marker	String	Não	mybucket10	Nome do bucket que inicia a listagem. A resposta inclui apenas buckets posteriores a este valor em ordem alfabética. Sem esse parâmetro, todos os buckets são retornados. Padrão: vazio.
max-keys	Integer	Não	10	Número máximo de buckets a retornar. Valores válidos: 1 a 1000. Valor padrão: 100.

Cabeçalhos da resposta

A resposta de uma solicitação ListBuckets (GetService) contém apenas cabeçalhos comuns de resposta. Para mais informações, consulte Cabeçalhos comuns de resposta.

Elementos da resposta

Nota

O XML de resposta do ListBuckets (GetService) omite Prefix, Marker, MaxKeys, IsTruncated e NextMarker quando todos os buckets são retornados.

Elemento	Tipo	Exemplo	Descrição
ListAllMyBucketsResult	Container	N/A	Contêiner raiz dos resultados de ListBuckets (GetService). Nós filhos: Owner e Buckets Nós pais: nenhum
Prefix	String	my	Prefixo usado para filtrar os buckets retornados. Nós pais: ListAllMyBucketsResult
Marker	String	mybucket	Nome do bucket onde a listagem do ListBuckets (GetService) começa. Nós pais: ListAllMyBucketsResult
MaxKeys	String	10	Número máximo de buckets retornados. Nós pais: ListAllMyBucketsResult
IsTruncated	String enumerada	true	Indica se todos os resultados foram retornados. Valores válidos: true: Nem todos os resultados foram retornados. false: Todos os resultados foram retornados. Nós pais: ListAllMyBucketsResult
NextMarker	String	mybucket10	Marcador de paginação para recuperar os resultados restantes. Nós pais: ListAllMyBucketsResult
Owner	Container	N/A	Contêiner com os detalhes do proprietário do bucket. Nós pais: ListAllMyBucketsResult
ID	String	ut_test_put_bucket	ID de usuário do proprietário do bucket. Nós pais: ListAllMyBucketsResult.Owner
DisplayName	String	ut_test_put_bucket	Nome de exibição do proprietário do bucket, equivalente ao ID de usuário. Nós pais: ListAllMyBucketsResult.Owner
Buckets	Container	N/A	Contêiner para múltiplas entradas de buckets. Nós filhos: Bucket Nós pais: ListAllMyBucketsResult
Bucket	Container	N/A	Contêiner com os detalhes individuais do bucket. Nós filhos: Name, CreationDate e Location Nós pais: ListAllMyBucketsResult.Buckets
Name	String	mybucket01	Nome do bucket. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
CreationDate	Time	2014-05-15T11:18:32.000Z	Data de criação do bucket. Formato: `yyyy-mm-ddThh:mm:ss.timezone`. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
Location	String	oss-cn-hangzhou	ID da região do OSS. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
ExtranetEndpoint	String	oss-cn-hangzhou.aliyuncs.com	Endpoint público do bucket. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
IntranetEndpoint	String	oss-cn-hangzhou-internal.aliyuncs.com	Endpoint interno do bucket. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
Region	String	cn-hangzhou	ID da região da Alibaba Cloud. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
StorageClass	String	Standard	Classe de armazenamento do bucket. Valores válidos: Standard, IA, Archive, ColdArchive e DeepColdArchive. Nós pais: ListAllMyBucketsResult.Buckets.Bucket
ResourceGroupId	String	rg-aek27tc****	ID do grupo de recursos do bucket. Buckets no grupo de recursos padrão retornam rg-default-id. Nós pais: ListAllMyBucketsResult.Buckets.Bucket

Exemplos

Listar todos os buckets na sua conta

Solicitações de exemplo

GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

Respostas de sucesso de exemplo

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 556
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>512**</ID>
    <DisplayName>51264</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-02-17T18:12:43.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-shanghai</Location>
      <Name>app-base-oss</Name>
      <Region>cn-shanghai</Region>
      <StorageClass>Standard</StorageClass>
    </Bucket>
    <Bucket>
      <CreationDate>2014-02-25T11:21:04.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>mybucket</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

Listar buckets por prefixo e max-keys

Solicitações de exemplo

GET /?prefix=my&max-keys=10 HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

Respostas de sucesso de exemplo

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 545
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Prefix>my</Prefix>
  <Marker>mybucket</Marker>
  <MaxKeys>10</MaxKeys>
  <IsTruncated>true</IsTruncated>
  <NextMarker>mybucket10</NextMarker>
  <Owner>
    <ID>ut_test_put_bucket</ID>
    <DisplayName>ut_test_put_bucket</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-05-14T11:18:32.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>mybucket01</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>Standard</StorageClass>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

Listar buckets em um grupo de recursos específico

Solicitações de exemplo

GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
x-oss-resource-group-id: rg-aek27tc********

Respostas de sucesso de exemplo

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 556
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>512**</ID>
    <DisplayName>51264</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-02-07T18:12:43.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-shanghai</Location>
      <Name>test-bucket-1</Name>
      <Region>cn-shanghai</Region>
      <StorageClass>Standard</StorageClass>
      <ResourceGroupId>rg-aek27tc********</ResourceGroupId>
    </Bucket>
    <Bucket>
      <CreationDate>2014-02-05T11:21:04.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>test-bucket-2</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
      <ResourceGroupId>rg-aek27tc********</ResourceGroupId>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

Listar buckets no grupo de recursos padrão

Solicitações de exemplo

GET / HTTP/1.1
Date: Thu, 15 May 2014 11:18:32 GMT
Host: oss-cn-hangzhou.aliyuncs.com
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=host,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
x-oss-resource-group-id: rg-default-id

Respostas de sucesso de exemplo

HTTP/1.1 200 OK
Date: Thu, 15 May 2014 11:18:32 GMT
Content-Type: application/xml
Content-Length: 556
Connection: keep-alive
Server: AliyunOSS
x-oss-request-id: 5374A2880232A65C2300****
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult>
  <Owner>
    <ID>512**</ID>
    <DisplayName>51264</DisplayName>
  </Owner>
  <Buckets>
    <Bucket>
      <CreationDate>2014-02-07T18:12:43.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-shanghai.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-shanghai-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-shanghai</Location>
      <Name>test-bucket-3</Name>
      <Region>cn-shanghai</Region>
      <StorageClass>Standard</StorageClass>
      <ResourceGroupId>rg-default-id</ResourceGroupId>
    </Bucket>
    <Bucket>
      <CreationDate>2014-02-05T11:21:04.000Z</CreationDate>
      <ExtranetEndpoint>oss-cn-hangzhou.aliyuncs.com</ExtranetEndpoint>
      <IntranetEndpoint>oss-cn-hangzhou-internal.aliyuncs.com</IntranetEndpoint>
      <Location>oss-cn-hangzhou</Location>
      <Name>test-bucket-4</Name>
      <Region>cn-hangzhou</Region>
      <StorageClass>IA</StorageClass>
      <ResourceGroupId>rg-default-id</ResourceGroupId>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>

SDK

Use os SDKs do OSS nas seguintes linguagens de programação para chamar ListBuckets (GetService):

ossutil

Para obter informações sobre o comando ossutil correspondente à operação ListBuckets, consulte list-buckets (get-service).

Códigos de erro

Código de erro	Código de status HTTP	Descrição
AccessDenied	403	A solicitação vem de um usuário anônimo e não inclui informações de autenticação de usuário.