Object Storage Service:PutBucketInventory

Name

Type

Required

Example

Description

Id

string

Yes

report1

The custom inventory name. It must meet the following requirements:

• The inventory name must be globally unique within the current bucket.

• The inventory name cannot exceed 192 characters.

IsEnabled

Boolean

Yes

true

Indicates whether the inventory feature is enabled.

Filter

container

No

N/A

The prefix for filtering objects in the inventory. After you specify a prefix, the inventory filters objects that match the prefix.

Prefix

string

No

Pics/

The prefix for filtering rules.

Parent node: Filter

LastModifyBeginTimeStamp

string

No

1637883649

The start UNIX timestamp of the last modified time for filtered files, in seconds.

Valid range: [1262275200, 253402271999]

LastModifyEndTimeStamp

string

No

1638347592

The end UNIX timestamp of the last modified time for filtered files, in seconds.

Valid range: [1262275200, 253402271999]

LowerSizeBound

string

No

1024

The minimum size of filtered files, in bytes.

Valid range: 0 B to 48.8 TB.

UpperSizeBound

string

No

1048576

The maximum size of filtered files, in bytes.

Valid range: greater than 0 B and up to 48.8 TB.

StorageClass

string

No

Standard,IA

The storage class of filtered files. You can specify multiple storage classes.

Destination

container

Yes

N/A

Stores the checklist results.

OSSBucketDestination

container

Yes

N/A

Information about the bucket where exported inventory results are stored.

Parent node: Destination

Format

string

Yes

CSV

The file format of the inventory file. Exported inventory files are CSV files compressed with GZIP.

Valid value: CSV

Parent node: OSSBucketDestination

AccountId

string

Yes

100000000000000

The AccountId granted by the bucket owner.

Parent node: OSSBucketDestination

RoleArn

string

Yes

acs:ram::100000000000000:role/AliyunOSSRole

The name of the role with permissions to read all files from the source bucket and write files to the destination bucket. Format: acs:ram::uid:role/rolename.

Parent node: OSSBucketDestination

Bucket

string

Yes

acs:oss:::bucket_0001

The bucket where exported inventory files are stored.

Parent node: OSSBucketDestination

Prefix

string

No

prefix1/

The prefix of the storage path for inventory files.

Parent node: OSSBucketDestination

Encryption

container

No

N/A

The encryption method for inventory files.

Valid values:

• SSE-OSS: Use OSS-managed keys for encryption and decryption.

• SSE-KMS: Use a default customer master key (CMK) managed by KMS or a specified CMK for encryption and decryption.

Parent node: OSSBucketDestination

For more information, see Server-side encryption.

SSE-OSS

container

No

N/A

The container for the SSE-OSS encryption method.

Parent node: Encryption

SSE-KMS

container

No

N/A

The container for the SSE-KMS encryption key.

Parent node: Encryption

KeyId

string

No

keyId

The KMS key ID.

Parent node: SSE-KMS

Schedule

container

Yes

N/A

The container for inventory export frequency information.

Frequency

string

Yes

Daily

The frequency of inventory file exports.

Valid values:

• Daily: Export inventory files daily.

• Weekly: Export inventory files weekly.

Parent node: Schedule

IncludedObjectVersions

string

Yes

All

Specifies whether to include object version information in the inventory.

OptionalFields

container

No

N/A

Configure the items included in the inventory results.

Field

string

No

Size

The configuration items included in the inventory results.

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

• VersionId: The object version ID. This field appears only when the inventory rule is configured to export all versions.

  • If versioning is not enabled for the bucket where inventory rules are configured, this field is empty.

  • If versioning is enabled for the bucket where inventory rules are configured, this field displays the object's VersionId.

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

  • If versioning is not enabled for the bucket where inventory rules are configured, this field defaults to false.

  • If versioning is enabled for the bucket where inventory rules are configured and the object is a delete marker, this field displays true. If the object is not a delete marker, this field displays false.

• Size: The object size.

• StorageClass: The object storage class.

• TransitionTime: The time when the object's storage class changed to Cold Archive or Deep Cold Archive due to lifecycle rules.

• LastModifiedDate: The object's last modified time.

• ETag: The object's ETag value, which identifies the object's content. An ETag is created when an object is generated to identify its content.

  • For objects created using the PutObject API, the ETag value is the MD5 hash of its content.

  • For objects created by other methods, the ETag value is a unique value generated based on specific calculation rules, but it is not the MD5 hash of its content.

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

• ObjectType: The object type.

• ObjectAcl: The object's access control list (ACL).

• Crc64: The object's CRC-64.

• EncryptionStatus: Indicates whether the object is encrypted.

• TaggingCount: The number of tags.

IncrementalInventory

container

No

N/A

The configuration container for incremental inventories.

IsEnabled

Boolean

Yes

true

Specifies whether to enable incremental inventories. Valid values:

• true: Enable.

• false: Disable.

If set to `true`, incremental inventories are enabled, even if `InventoryConfiguration/IsEnabled` is `false`.

Parent node: IncrementalInventory

Schedule

container

Yes

N/A

The container for incremental inventory export frequency information.

Parent node: IncrementalInventory

Frequency

Positive integer

Yes

600

The export frequency for incremental inventories, in seconds.

The system currently uses a fixed period of 600 seconds. For each period, it automatically creates a directory prefix and generates a manifest file and multiple CSV files for that period. Custom frequency settings are not supported.

Parent node: Schedule

OptionalFields

container

No

N/A

The configuration container for incremental inventory file properties.

Parent node: IncrementalInventory

Field

string

No

Size

The configuration items included in the incremental inventory.

Parent node: OptionalFields

• SequenceNumber: The serial number. Each record has a unique SequenceNumber. Records under the same bucket and object can be sorted by SequenceNumber, which usually ensures a chronological order.

• RecordType: The event type: CREATE, UPDATE_METADATA, DELETE.

  • CREATE: All upload methods that occur under the selected prefix, such as Put/Post/Append/MultipartUpload/Copy.

  • UPDATE_METADATA: All metadata updates under the selected prefix are recorded under this type.

  • DELETE: All deletion methods for files under the selected prefix, such as DeleteObject/DeleteMultipleObjects, DeleteMarker generation after enabling versioning, and lifecycle deletion. Deletions include DeleteMarker and permanent deletion. For permanent deletion records, only the core fields Bucket, Key, SequenceNumber, RecordType, RecordTimestamp, and VersionId are retained. All other columns are null.

• RecordTimestamp: The timestamp (example: "2024-08-25 18:08:01.024"), in Greenwich Mean Time (GMT) with millisecond precision.

• Requester: The requester's Alibaba Cloud ID or Principal ID.

• RequestId: The unique ID of the request.

• SourceIp: The requester's source IP address.

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

• VersionId: The object version ID. This field appears only when the inventory rule is configured to export all versions.

  • If versioning is not enabled for the bucket where inventory rules are configured, this field is empty.

  • If versioning is enabled for the bucket where inventory rules are configured, this field displays the object's VersionId.

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

  • If versioning is not enabled for the bucket where inventory rules are configured, this field defaults to false.

  • If versioning is enabled for the bucket where inventory rules are configured and the object is a delete marker, this field displays true. If the object is not a delete marker, this field displays false.

• Size: The object size.

• StorageClass: The object storage class.

• LastModifiedDate: The object's last modified time.

• ETag: The object's ETag value, which identifies the object's content. An ETag is created when an object is generated to identify its content.

  • For objects created using the PutObject API, the ETag value is the MD5 hash of its content.

  • For objects created by other methods, the ETag value is a unique value generated based on specific calculation rules, but it is not the MD5 hash of its content.

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

• ObjectType: The object type.

• ObjectAcl: The object's access control list (ACL).

• Crc64: The object's CRC-64.

• EncryptionStatus: Indicates whether the object is encrypted.

Error code

HTTP status code

Description

InvalidArgument

400

Invalid parameters are passed.

InventoryExceedLimit

400

The number of inventory configuration rules exceeds the limit.

AccessDenied

403

• No user authentication information is provided when initiating a PutBucketInventory request.

• The user has no operation permissions.

InventoryAlreadyExist

409

The requested inventory rule already exists.