Object Storage Service:GetBucketInventory

Usage notes

By default, an Alibaba Cloud account has the permission to view the specified inventory configuration of a bucket. To call this operation as a Resource Access Management (RAM) user or by using Security Token Service (STS), you must have the oss:GetBucketInventory permission.

Request syntax

GET /?inventory&inventoryId=inventoryId HTTP/1.1

Request parameters

Response elements

The following table describes the elements returned in the response. Some elements apply only to specific inventory configurations. For example, DayOfMonth applies only when Frequency is set to Monthly, and AutoDelete applies only when Frequency is set to Once. The elements that are specific to incremental inventories are described in the following subsection.

Incremental inventory record fields

The following fields describe records in an incremental inventory file:

• SequenceNumber: The serial number of the record. The SequenceNumber of each record is unique. Records of the same object in the same bucket can be sorted by SequenceNumber, and the sorted records typically follow chronological order.

• RecordType: The event type. Valid values:

  • CREATE: all upload operations that occur under the selected prefix, such as Put, Post, Append, MultipartUpload, and Copy.

  • UPDATE_METADATA: all metadata updates under the selected prefix.

  • DELETE: all deletion operations of objects under the selected prefix, such as DeleteObject and DeleteMultipleObjects, the generation of a delete marker after versioning is enabled, and lifecycle-based deletion. Deletions include creating a delete marker and permanent deletion. For a permanent deletion, the record retains only the core fields Bucket, Key, SequenceNumber, RecordType, RecordTimestamp, and VersionId, and all other columns are null.

• RecordTimestamp: The timestamp of the record, in Greenwich Mean Time and accurate to the millisecond. Example: 2024-08-25 18:08:01.024.

• Requester: The Alibaba Cloud ID or Principal ID of the requester.

• RequestId: The unique identifier of the request.

• SourceIp: The source IP address of the requester.

• Key: The URL-encoded name of the object in the bucket.

• VersionId: The version ID of the object. This field appears only when the configured inventory rule exports all versions.

  • If versioning is not enabled on the bucket for which the inventory rule is configured, this field is empty.

  • If versioning is enabled on the bucket for which the inventory rule is configured, this field displays the VersionId of the object.

• IsDeleteMarker: Specifies whether the object version is a delete marker. This field appears only when the configured inventory rule exports all versions.

  • If versioning is not enabled on the bucket for which the inventory rule is configured, this field defaults to false.

  • If versioning is enabled on the bucket for which the inventory rule is configured, this field is true when the object is a delete marker, and false when the object is not a delete marker.

• Size: The size of the object.

• StorageClass: The storage class of the object.

• LastModifiedDate: The last modified time of the object.

• ETag: The ETag of the object. An ETag is created when the object is generated and identifies the content of the object.

  • For an object created by using the PutObject operation, the ETag is the MD5 hash of its content.

  • For an object created by using other methods, the ETag is a unique value generated based on certain calculation rules and is not the MD5 hash of its content.

• IsMultipartUploaded: Specifies whether the object was uploaded by using multipart upload.

• ObjectType: The type of the object.

• ObjectAcl: The access control list of the object.

• Crc64: The CRC-64 value of the object.

• EncryptionStatus: Specifies whether the object is encrypted.

Examples

• Example request

GET /?inventory&inventoryId=report1 HTTP/1.1

• Example response

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

The following SDKs support this operation:

• Java

• Python V2

• Go V2

• Node.js

• C++

• .NET

ossutil CLI

For the ossutil command that corresponds to the GetBucketInventory operation, see get-bucket-inventory.