Object Storage Service:GetBucketInventory

Name

Type

Required

Description

inventoryId

String

Yes

The ID of the inventory task to query.

Name

Type

Description

Id

String

The inventory name that you specify. The name must be globally unique in the bucket.

IsEnabled

Boolean

Indicates whether the inventory feature is enabled.

Filter

Container

The prefix used to filter objects. Only objects whose names contain the specified prefix are included in the inventory list.

Prefix

String

The prefix used in the filter rule.

Parent node: Filter

Destination

Container

Details of the checklist results.

OSSBucketDestination

Container

Information about the bucket that stores exported inventory lists.

Parent node: Destination

Format

String

The format of exported inventory lists.

Valid value: CSV

Parent node: OSSBucketDestination

AccountId

String

The account ID granted by the bucket owner.

Parent node: OSSBucketDestination

RoleArn

String

The role name to which the bucket owner grants permissions.

Format: acs:ram::uid:role/rolename

Parent node: OSSBucketDestination

Bucket

String

The bucket that stores exported inventory lists.

Parent node: OSSBucketDestination

Prefix

String

The prefix in the path where exported inventory lists are stored.

Parent node: OSSBucketDestination

Encryption

Container

The encryption method used for exported inventory lists.

Valid values: SSE-OSS, SSE-KMS, and null

Parent node: OSSBucketDestination

SSE-OSS

Container

The container for the SSE-OSS encryption method.

Parent node: Encryption

SSE-KMS

Container

The container that stores the customer master key (CMK) used in the SSE-KMS encryption method.

Parent node: Encryption

KeyId

String

The ID of the key managed by Key Management Service (KMS).

Parent node: SSE-KMS

Schedule

Container

The container that stores information about how often inventory lists are exported.

Frequency

String

How often inventory lists are exported.

Valid values: Daily and Weekly

Parent node: Schedule

IncludedObjectVersions

String

Indicates whether to include version information for objects in inventory lists.

OptionalFields

Container

The configuration fields to include in inventory lists.

Field

String

The configuration fields to include in inventory lists.

Valid values: Size, LastModifiedDate, TransitionTime, ETag, StorageClass, IsMultipartUploaded, EncryptionStatus, ObjectAcl, TaggingCount, ObjectType, and CRC64

Parent node: OptionalFields

IncrementalInventory

Container

Configuration information for incremental inventories.

IsEnabled

Boolean

Indicates whether to enable incremental inventories.

Valid values:

• true: Enable

• false: Disable

If set to true, the incremental inventory feature is enabled regardless of whether the top-level IsEnabled parameter is set to false.

Parent node: IncrementalInventory

Schedule

Container

The export frequency for incremental inventories.

Parent node: IncrementalInventory

Frequency

Positive integer

The export frequency for incremental inventories, in seconds.

The system uses a fixed interval of 600 seconds. For each interval, the system automatically creates a directory prefix and generates a manifest file and multiple CSV files for objects created during that interval. Custom frequencies are not supported.

Parent node: Schedule

OptionalFields

Container

The configuration fields to include in incremental inventories.

Parent node: IncrementalInventory

Field

String

The configuration fields to include in incremental inventories.

Parent node: OptionalFields

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

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

  • CREATE: All upload operations under the selected prefix, such as PutObject, PostObject, AppendObject, MultipartUpload, and CopyObject.

  • UPDATE_METADATA: All metadata updates under the selected prefix.

  • DELETE: All deletion operations under the selected prefix, such as DeleteObject and DeleteMultipleObjects. When versioning is enabled, this includes delete markers. Lifecycle-based deletions are also included. Permanent deletions record only these core fields: Bucket, Key, SequenceNumber, RecordType, RecordTimestamp, and VersionId. All other columns are null.

• RecordTimestamp: A timestamp in ISO 8601 format, such as "2024-08-25 18:08:01.024". Uses Greenwich Mean Time (GMT) with millisecond precision.

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

• RequestId: The unique ID of the request.

• SourceIp: The source IP address of the requester.

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

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

  • If versioning is disabled for the bucket, this field is empty.

  • If versioning is enabled for the bucket, this field shows 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 disabled for the bucket, this field defaults to false.

  • If versioning is enabled for the bucket and the object is a delete marker, this field shows true. If the object is not a delete marker, this field shows false.

• Size: The size of the object.

• StorageClass: The storage class of the object.

• LastModifiedDate: The last modified time of the object.

• ETag: The ETag value of the object, used to identify its content. An ETag is generated when the object is created.

  • For objects created using the PutObject operation, the ETag is the MD5 hash of the object's content.

  • For objects created using other methods, the ETag is a unique value generated by a specific algorithm, but it is not the MD5 hash of the content.

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

• ObjectType: The type of the object.

• ObjectAcl: The access control list (ACL) of the object.

• CRC64: The CRC-64 checksum of the object.

• EncryptionStatus: Indicates whether the object is encrypted.