Todos os produtos
Search
Central de documentação

Object Storage Service:GetBucketInventory

Última atualização: Aug 28, 2026

A operação GetBucketInventory consulta a configuração de inventário especificada de um bucket.

Notas de uso

Por padrão, uma conta Alibaba Cloud tem permissão para visualizar a configuração de inventário especificada de um bucket. Para chamar esta operação como usuário do Resource Access Management (RAM) ou usando o Security Token Service (STS), é necessária a permissão oss:GetBucketInventory.

Sintaxe da solicitação

GET /?inventory&inventoryId=inventoryId HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

inventoryId

string

Sim

ID da regra de inventário a consultar.

Elementos da resposta

A tabela a seguir descreve os elementos retornados na resposta. Alguns elementos aplicam-se apenas a configurações de inventário específicas. Por exemplo, DayOfMonth aplica-se somente quando Frequency está definido como Monthly, e AutoDelete aplica-se somente quando Frequency está definido como Once. A subseção seguinte descreve os elementos específicos para inventários incrementais.

Elemento

Tipo

Descrição

Id

string

Nome do inventário especificado pelo usuário. O nome deve ser exclusivo no bucket.

IsEnabled

boolean

Indica se o inventário está ativado. Valores válidos: true e false. Se o valor for true, o recurso de inventário entra em vigor. Se for false, nenhum inventário será gerado.

Filter

container

Prefixo usado para filtrar o inventário. Se um prefixo for especificado, o inventário incluirá apenas os objetos cujos nomes correspondam a esse prefixo.

Prefix

string

Prefixo de correspondência da regra de filtro. Nó pai: Filter

Destination

container

Informações sobre o local de armazenamento dos resultados do inventário.

OSSBucketDestination

container

Detalhes do bucket onde os resultados exportados do inventário são armazenados. Nó pai: Destination

Format

string

Formato do arquivo de inventário exportado. Valores válidos: CSV e Parquet. Atualmente, o formato Parquet tem suporte apenas na região UK (London). Nó pai: OSSBucketDestination

AccountId

string

ID da conta concedido pelo proprietário do bucket. Nó pai: OSSBucketDestination

RoleArn

string

Nome da função concedida pelo proprietário do bucket para permissões de operação. Formato: acs:ram::uid:role/rolename Nó pai: OSSBucketDestination

Bucket

string

Bucket onde o arquivo de inventário exportado é armazenado. Nó pai: OSSBucketDestination

Prefix

string

Prefixo do caminho de armazenamento do arquivo de inventário. Nó pai: OSSBucketDestination

Encryption

container

Método de criptografia do arquivo de inventário. Valores válidos: SSE-OSS e SSE-KMS. Este elemento estará vazio se o arquivo de inventário não estiver criptografado. Nó pai: OSSBucketDestination

SSE-OSS

container

Container do método de criptografia SSE-OSS. Nó pai: Encryption

SSE-KMS

container

Container da chave usada no método de criptografia SSE-KMS. Nó pai: Encryption

KeyId

string

ID da chave KMS. Nó pai: SSE-KMS

Schedule

container

Container com as informações de agendamento da exportação do inventário.

Frequency

string

Agendamento para exportação do arquivo de inventário. Valores válidos: Daily, Weekly, Monthly e Once. Nó pai: Schedule

DayOfMonth

positive integer

Dia do mês em que o inventário é exportado. Este elemento aplica-se apenas quando Frequency está definido como Monthly. Valores válidos: 1 a 31. Nó pai: Schedule

AutoDelete

boolean

Define se a configuração de inventário será excluída automaticamente após a conclusão da execução única do inventário. Este elemento aparece apenas quando Frequency está definido como Once. Valores válidos: true e false. Nó pai: Schedule

IncludedObjectVersions

string

Especifica se as informações de versão do objeto devem ser incluídas no inventário. Valores válidos: All e Current. Se o valor for All, as informações de todas as versões do objeto serão exportadas. Se for Current, apenas as informações da versão atual do objeto serão exportadas.

OptionalFields

container

Itens de configuração a incluir nos resultados do inventário.

Field

string

Itens de configuração incluídos nos resultados do inventário. Itens opcionais: Size, LastModifiedDate, TransitionTime, ETag, StorageClass, IsMultipartUploaded, EncryptionStatus, ObjectAcl, TaggingCount, ObjectType e Crc64. Nó pai: OptionalFields

Elementos do inventário incremental

A tabela abaixo detalha os elementos exclusivos dos inventários incrementais.

Elemento

Tipo

Descrição

IncrementalInventory

container

Informações de configuração do inventário incremental.

IsEnabled

boolean

Define se o inventário incremental deve ser ativado. Valores válidos: true (ativado) e false (desativado). Quando o valor é true, o recurso de inventário incremental é ativado e não é afetado mesmo que o elemento pai esteja definido como false. Nó pai: IncrementalInventory

Schedule

container

Agendamento da exportação do inventário incremental. Nó pai: IncrementalInventory

Frequency

positive integer

Frequência de exportação do inventário incremental, em segundos. O sistema utiliza atualmente um período fixo de 600 segundos. Em cada período, o system cria automaticamente um prefixo de diretório e gera o arquivo de manifesto correspondente, além de múltiplos arquivos CSV produzidos nesse intervalo. Não há suporte para configurações personalizadas de frequência. Nó pai: Schedule

OptionalFields

container

Itens de configuração a incluir no inventário incremental. Nó pai: IncrementalInventory

Field

string

Itens de configuração incluídos no inventário incremental. Nó pai: OptionalFields

Campos de registro do inventário incremental

Os campos a seguir descrevem os registros em um arquivo de inventário incremental:

  • SequenceNumber: Número de série do registro. O SequenceNumber de cada registro é único. Registros do mesmo objeto no mesmo bucket podem ser ordenados por SequenceNumber, e os registros classificados geralmente seguem a ordem cronológica.

  • RecordType: Tipo de evento. Valores válidos:

    • CREATE: todas as operações de upload ocorridas sob o prefixo selecionado, como Put, Post, Append, MultipartUpload e Copy.

    • UPDATE_METADATA: todas as atualizações de metadados sob o prefixo selecionado.

    • DELETE: todas as operações de exclusão de objetos sob o prefixo selecionado, como DeleteObject e DeleteMultipleObjects, a geração de um marcador de exclusão após a ativação do versionamento e a exclusão baseada em ciclo de vida. As exclusões incluem a criação de um marcador de exclusão e a exclusão permanente. Para uma exclusão permanente, o registro mantém apenas os campos principais Bucket, Key, SequenceNumber, RecordType, RecordTimestamp e VersionId, enquanto todas as outras colunas ficam nulas.

  • RecordTimestamp: Timestamp do registro, no Horário de Greenwich e com precisão de milissegundos. Exemplo: 2024-08-25 18:08:01.024.

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

  • RequestId: Identificador exclusivo da solicitação.

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

  • Key: Nome do objeto codificado por URL no bucket.

  • VersionId: ID da versão do objeto. Este campo aparece apenas quando a regra de inventário configurada exporta todas as versões.

    • Se o versionamento não estiver ativado no bucket para o qual a regra de inventário foi configurada, este campo ficará vazio.

    • Caso o versionamento esteja ativado no bucket associado à regra de inventário, este campo exibirá o VersionId do objeto.

  • IsDeleteMarker: Indica se a versão do objeto é um marcador de exclusão. Este campo aparece apenas quando a regra de inventário configurada exporta todas as versões.

    • Se o versionamento não estiver ativado no bucket para o qual a regra de inventário foi configurada, o valor padrão deste campo será false.

    • Quando o versionamento estiver ativado no bucket associado à regra de inventário, este campo será true se o objeto for um marcador de exclusão e false caso contrário.

  • Size: Tamanho do objeto.

  • StorageClass: Classe de armazenamento do objeto.

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

  • ETag: ETag do objeto. Um ETag é criado quando o objeto é gerado e identifica o conteúdo do objeto.

    • Para um objeto criado usando a operação PutObject, o ETag corresponde ao hash MD5 do seu conteúdo.

    • Para objetos criados por outros métodos, o ETag é um valor exclusivo gerado com base em regras de cálculo específicas e não representa o hash MD5 do conteúdo.

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

  • ObjectType: Tipo do objeto.

  • ObjectAcl: Lista de controle de acesso do objeto.

  • Crc64: Valor CRC-64 do objeto.

  • EncryptionStatus: Indica se o objeto está criptografado.

Exemplos

  • Exemplo de solicitação

GET /?inventory&inventoryId=report1 HTTP/1.1
  • Exemplo de resposta

HTTP/1.1 200 OK
  x-oss-request-id: 56594298207FB304438516F9
  Date: Mon, 31 Oct 2016 12:00:00 GMT
  Server: AliyunOSS
  Content-Length: length

  <?xml version="1.0" encoding="UTF-8"?>
  <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:::bucket_0001</Bucket>
           <Prefix>prefix1</Prefix>
           <Encryption>
              <SSE-OSS/>
           </Encryption>
        </OSSBucketDestination>
     </Destination>
     <Schedule>
        <Frequency>Daily</Frequency>
     </Schedule>
     <Filter>
       <Prefix>myprefix/</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>

SDKs

Os seguintes SDKs oferecem suporte a esta operação:

ossutil CLI

Para obter o comando ossutil correspondente à operação GetBucketInventory, consulte get-bucket-inventory.