Todos os produtos
Search
Central de documentação

Object Storage Service:ListBucketInventory

Última atualização: Sep 09, 2026

A operação ListBucketInventory lista todas as configurações de inventário de um bucket.

Observações de uso

A chamada à operação ListBucketInventory exige a permissão oss:GetBucketInventory. Para mais informações, consulte Grant custom permission policies to a RAM user.

Nota
  • Uma única solicitação recupera no máximo 100 configurações de inventário. Se a resposta for truncada, use o valor NextContinuationToken da resposta como continuation-token na próxima solicitação para obter a página seguinte de resultados.

  • Verifique se você tem permissão para gerenciar as configurações de inventário do bucket. Por padrão, apenas o proprietário do bucket possui essa permissão. Caso não seja o proprietário, solicite a permissão necessária.

Sintaxe da solicitação

  • Com continuation-token

    GET /?inventory&continuation-token=xxx HTTP/1.1
  • Sem continuation-token

    GET /?inventory HTTP/1.1

Elementos da resposta

Parâmetro

Tipo

Descrição

InventoryConfiguration

container

Contêiner dos parâmetros de configuração de inventário.

IsTruncated

Boolean

Indica se a lista de configurações de inventário foi truncada.

Valores válidos: true ou false

  • Se false, todas as configurações de inventário do bucket estão listadas.

  • Se true, a lista está truncada. Use NextContinuationToken para recuperar a próxima página de resultados.

NextContinuationToken

String

Se a resposta estiver truncada (IsTruncated é true), use este token no parâmetro continuation-token da próxima solicitação para obter a página seguinte de resultados.

Id

String

Nome especificado pelo usuário para a configuração de inventário. O nome deve ser exclusivo dentro do bucket.

IsEnabled

Boolean

Defina se o inventário está ativado.

Valores válidos: true ou false

  • Se true, o inventário está ativado.

  • Se false, nenhum inventário é gerado.

Filter

container

Contêiner das regras de filtro. O inventário inclui apenas objetos correspondentes ao filtro.

Prefix

String

Prefixo de objeto usado para filtragem.

Nó pai: Filter

Destination

container

Contêiner com informações sobre o local de publicação dos resultados do inventário.

OSSBucketDestination

container

Detalhes sobre o bucket de destino onde o relatório de inventário é armazenado.

Nó pai: Destination

Format

String

Formato de arquivo do inventário exportado.

Valores válidos: CSV, Parquet (o formato Parquet tem suporte apenas na região UK (London).)

Nó pai: OSSBucketDestination

AccountId

String

ID da conta com permissão para gravar o relatório de inventário no bucket de destino.

Nó pai: OSSBucketDestination

RoleArn

String

ARN da função com permissão para gravar o relatório de inventário no bucket de destino.

Formato: acs:ram::uid:role/rolename

Nó pai: OSSBucketDestination

Bucket

String

Bucket de destino do relatório de inventário.

Nó pai: OSSBucketDestination

Prefix

String

Prefixo no bucket de destino onde o relatório de inventário é armazenado.

Nó pai: OSSBucketDestination

Encryption

container

Método de criptografia no lado do servidor para o relatório de inventário.

Valores válidos: SSE-OSS, SSE-KMS ou Null

Nó pai: OSSBucketDestination

SSE-OSS

container

Contêiner da criptografia SSE-OSS.

Nó pai: Encryption

SSE-KMS

container

Contêiner da chave usada na criptografia SSE-KMS.

Nó pai: Encryption

KeyId

String

ID da chave KMS.

Nó pai: SSE-KMS

Schedule

container

Contêiner da programação de exportação do inventário.

Frequency

String

Frequência de exportação do inventário.

Valores válidos: Daily, Weekly, Monthly ou Once

Nó pai: Schedule

DayOfMonth

Integer

Dia do mês de exportação do inventário quando Frequency estiver definido como Monthly. Valores válidos: 1 a 31.

Nó pai: Schedule

AutoDelete

Boolean

Defina se a configuração de inventário deve ser excluída automaticamente após a exportação de um inventário único. Este elemento é válido apenas quando Frequency está definido como Once.

Valores válidos: true, false

Nó pai: Schedule

IncludedObjectVersions

String

Especifica quais versões de objeto incluir no inventário.

Valores válidos: All ou Current

  • Se o valor for All, todas as versões dos objetos serão exportadas.

  • Se o valor for Current, apenas as versões atuais dos objetos serão exportadas.

OptionalFields

container

Contêiner dos campos opcionais a serem incluídos no inventário.

Field

container

Campos opcionais a serem incluídos no inventário.

Os campos opcionais incluem: Size, LastModifiedDate, TransitionTime, ETag, StorageClass, IsMultipartUploaded, EncryptionStatus, ObjectAcl, TaggingCount, ObjectType e Crc64

Nó pai: OptionalFields

IncrementalInventory

container

Contêiner da configuração de inventário incremental.

IsEnabled

Boolean

Indica se o inventário incremental deve ser ativado.

Valores válidos:

  • true: ativado

  • false: desativado

Se true, o inventário incremental será ativado mesmo que o IsEnabled pai seja false.

Nó pai: IncrementalInventory

Schedule

container

Contêiner da programação de exportação do inventário incremental.

Nó pai: IncrementalInventory

Frequency

Integer

Frequência de exportação do inventário incremental, em segundos.

O sistema exporta inventários incrementais em um intervalo fixo de 600 segundos. Em cada intervalo, o sistema cria automaticamente um prefixo de diretório e gera um arquivo de manifesto e vários arquivos CSV. Não há suporte para frequências personalizadas.

Nó pai: Schedule

OptionalFields

container

Contêiner dos campos opcionais a serem incluídos no inventário incremental.

Nó pai: IncrementalInventory

Field

String

Campos incluídos no inventário incremental.

Nó pai: OptionalFields

  • SequenceNumber: Número de sequência. Cada registro possui um número de sequência exclusivo. Registros do mesmo objeto no mesmo bucket podem ser ordenados por SequenceNumber. Os registros ordenados geralmente seguem uma ordem cronológica.

  • RecordType: Tipo de evento. Valores válidos: CREATE, UPDATE_METADATA e DELETE.

    • CREATE: Todas as operações de upload, como PutObject, PostObject, AppendObject, upload multipart e CopyObject, que ocorrem para objetos com o prefixo especificado.

    • UPDATE_METADATA: Todas as atualizações de metadados para objetos com o prefixo especificado são registradas como este tipo de evento.

    • DELETE: Todas as operações de exclusão para objetos com o prefixo especificado, como DeleteObject, DeleteMultipleObjects, criação de marcador de exclusão após a ativação do versionamento e exclusões baseadas em ciclo de vida. As exclusões incluem a criação de um marcador de exclusão e exclusões permanentes. Para exclusões permanentes, apenas os campos principais Bucket, Key, SequenceNumber, RecordType, RecordTimestamp e VersionId são mantidos. Outras colunas ficam vazias (null).

  • RecordTimestamp: Timestamp UTC do evento. Exemplo: "2024-08-25 18:08:01.024". O timestamp tem precisão de milissegundos.

  • Requester: ID da Alibaba Cloud ou ID principal do solicitante.

  • RequestId: ID exclusivo da solicitação.

  • SourceIp: Endereço IP de source do solicitante.

  • Key: Nome do objeto no bucket. A chave é codificada em URL.

  • VersionId: ID da versão do objeto. Este campo aparece apenas quando a configuração de inventário está definida para incluir todas as versões.

    • Se o versionamento não estiver ativado para o bucket, este campo estará vazio.

    • Se o versionamento estiver ativado para o bucket, este campo exibirá o ID da versão do objeto.

  • IsDeleteMarker: Indica se a versão do objeto é um marcador de exclusão. Este campo aparece apenas quando a configuração de inventário está definida para incluir todas as versões.

    • Se o versionamento não estiver ativado para o bucket, este campo assume o valor padrão false.

    • Se o versionamento estiver ativado e a versão do objeto for um marcador de exclusão, este campo será true. Caso contrário, será false.

  • Size: Tamanho do objeto.

  • StorageClass: Classe de armazenamento do objeto.

  • LastModifiedDate: Hora da última modificação do objeto.

  • ETag: Quando um objeto é criado, um ETag é gerado para identificar seu conteúdo.

    • Para um objeto criado pela chamada da operação PutObject, o ETag é o hash MD5 do seu conteúdo.

    • Para um objeto criado por outros métodos, o ETag é um valor exclusivo calculado com base em regras específicas, mas não é o hash MD5 do seu conteúdo.

  • IsMultipartUploaded: Indica se o objeto foi enviado usando upload multipart.

  • ObjectType: Tipo do objeto.

  • ObjectAcl: Lista de controle de acesso (ACL) do objeto.

  • Crc64: Valor CRC-64 do objeto.

  • EncryptionStatus: Indica se o objeto está criptografado.

Exemplos

  • Exemplo de solicitação

      GET /?inventory HTTP/1.1
      Host: BucketName.oss.aliyuncs.com
      Date: Fri, 24 Feb 2012 03:55:00 GMT
      Authorization: authorization string
      Content-Type: text/plain
  • Exemplo de resposta

      HTTP/1.1 200 OK
      x-oss-request-id: 56594298207FB304438516F9
      Date: Sat, 30 Apr 2016 23:29:37 GMT
      Content-Type: application/xml
      Content-Length: length
      Connection: close
      Server: AliyunOSS
    
      <?xml version="1.0" encoding="UTF-8"?>
      <ListInventoryConfigurationsResult>
         <InventoryConfiguration>
            <Id>report1</Id>
            <IsEnabled>true</IsEnabled>
            <Destination>
               <OSSBucketDestination>
                  <Format>CSV</Format>
                  <AccountId>1000000000000000</AccountId>
                  <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn>
                  <Bucket>acs:oss:::destination-bucket</Bucket>
                  <Prefix>prefix1</Prefix>
               </OSSBucketDestination>
            </Destination>
            <Schedule>
               <Frequency>Daily</Frequency>
            </Schedule>
            <Filter>
               <Prefix>prefix/One</Prefix>
            </Filter>
            <IncludedObjectVersions>All</IncludedObjectVersions>
            <OptionalFields>
               <Field>Size</Field>
               <Field>LastModifiedDate</Field>
               <Field>ETag</Field>
               <Field>StorageClass</Field>
               <Field>IsMultipartUploaded</Field>
               <Field>EncryptionStatus</Field>
            </OptionalFields>
         </InventoryConfiguration>
         <InventoryConfiguration>
            <Id>report2</Id>
            <IsEnabled>true</IsEnabled>
            <Destination>
               <OSSBucketDestination>
                  <Format>CSV</Format>
                  <AccountId>1000000000000000</AccountId>
                  <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn>
                  <Bucket>acs:oss:::destination-bucket</Bucket>
                  <Prefix>prefix2</Prefix>
               </OSSBucketDestination>
            </Destination>
            <Schedule>
               <Frequency>Daily</Frequency>
            </Schedule>
            <Filter>
               <Prefix>prefix/Two</Prefix>
            </Filter>
            <IncludedObjectVersions>All</IncludedObjectVersions>
            <OptionalFields>
               <Field>Size</Field>
               <Field>LastModifiedDate</Field>
               <Field>ETag</Field>
               <Field>StorageClass</Field>
               <Field>IsMultipartUploaded</Field>
               <Field>EncryptionStatus</Field>
            </OptionalFields>
         </InventoryConfiguration>
         <InventoryConfiguration>
            <Id>report3</Id>
            <IsEnabled>true</IsEnabled>
            <Destination>
               <OSSBucketDestination>
                  <Format>CSV</Format>
                  <AccountId>1000000000000000</AccountId>
                  <RoleArn>acs:ram::1000000000000000:role/AliyunOSSRole</RoleArn>
                  <Bucket>acs:oss:::destination-bucket</Bucket>
                  <Prefix>prefix3</Prefix>
               </OSSBucketDestination>
            </Destination>
            <Schedule>
               <Frequency>Daily</Frequency>
            </Schedule>
            <Filter>
               <Prefix>prefix/Three</Prefix>
            </Filter>
            <IncludedObjectVersions>All</IncludedObjectVersions>
            <OptionalFields>
               <Field>Size</Field>
               <Field>LastModifiedDate</Field>
               <Field>ETag</Field>
               <Field>StorageClass</Field>
               <Field>IsMultipartUploaded</Field>
               <Field>EncryptionStatus</Field>
            </OptionalFields>
         </InventoryConfiguration>
          ...
         <IsTruncated>true</IsTruncated>
         <NextContinuationToken>...</NextContinuationToken> 
      </ListInventoryConfigurationsResult>

SDKs

Chame esta operação usando os seguintes SDKs:

Ossutil CLI

Para executar esta operação com o ossutil, consulte o comando list-bucket-inventory.