List Bucket Inventory¶

OBS uses the GET method without inventory IDs to obtain all inventories of a specified bucket. Obtained inventories are returned together on only one page.

To perform this operation, you must have the GetBucketInventoryConfiguration permission. By default, only the bucket owner can delete the tags of a bucket. The bucket owner can allow other users to perform this operation by setting a bucket policy or granting them the permission.

Request Syntax¶

GET /?inventory HTTP/1.1
User-Agent: curl/7.29.0
Host: bucketname.obs.region.example.com
Accept: */*
Date: date
Authorization: authorization string

Request Parameters¶

This request message does not contain the request parameters.

Request Headers¶

This request uses common headers. For details about common request headers, see the section Common Request Headers.

Request Elements¶

This request involves no elements.

Response Syntax¶

HTTP/1.1 status_code
Server: OBS
x-amz-request-id: request id
x-amz-id-2: id
Content-Type: application/xml
Date: date
Content-Length: length

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListInventoryConfiguration  xmlns="http://obs.region.example.com/doc/2015-06-30/">
 <InventoryConfiguration>
  <Id>id</Id>
   <IsEnabled>true</IsEnabled>
   <Destination>
     <Format>CSV</Format>
     <Bucket>bucket</Bucket>
     <Prefix>prefix</Prefix>
   </Destination>
   <Schedule>
     <Frequency>Daily</Frequency>
   </Schedule>
   <IncludedObjectVersions>Current</IncludedObjectVersions>
   <OptionalFields>
     <Field>Size</Field>
     <Field>LastModifiedDate</Field>
     <Field>ETag</Field>
     <Field>IsMultipartUploaded</Field>
     <Field>ReplicationStatus</Field>
   </OptionalFields>
 </InventoryConfiguration>
</ListInventoryConfiguration>

Response Headers¶

This response uses common headers. For details about common response headers, see the section Common Response Headers.

Response Elements¶

Table 1 lists elements contained in the response body.

**Table 1** Bucket inventory configuration elements¶
Element	Description
ListInventoryConfiguration	List of bucket inventories. Type: Container
InventoryConfiguration	Bucket inventory configuration. For details about the configuration elements, see Table 2. Type: Container Ancestor: ListInventoryConfiguration

Error Responses¶

No special error responses are returned. For details about error responses, see Table 1.

Sample Request¶

GET /?inventory HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: Tue, 08 Jan 2019 09:32:24 +0000
Authorization: AWS UDSIAMSTUBTEST000001:ySWncC9M08jNsyXdJLSMJkpi7XM=

Sample Response¶

HTTP/1.1 200 OK
Server: OBS
x-amz-request-id: 000001682CB4C2EE6808A0D8DF9F3D00
x-amz-id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSBjn5O7Jv9CqvUMO0BenehRdil1n8rR
Content-Type: application/xml
Date: Tue, 08 Jan 2019 09:04:30 GMT
Content-Length: 626

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ListInventoryConfiguration  xmlns="http://obs.region.example.com/doc/2015-06-30/">
 <InventoryConfiguration>
  <Id>id1</Id>
   <IsEnabled>true</IsEnabled>
   <Destination>
     <Format>CSV</Format>
     <Bucket>bucket</Bucket>
     <Prefix>prefix</Prefix>
   </Destination>
   <Schedule>
     <Frequency>Daily</Frequency>
   </Schedule>
   <IncludedObjectVersions>Current</IncludedObjectVersions>
   <OptionalFields>
     <Field>Size</Field>
     <Field>LastModifiedDate</Field>
     <Field>ETag</Field>
     <Field>IsMultipartUploaded</Field>
     <Field>ReplicationStatus</Field>
   </OptionalFields>
 </InventoryConfiguration>
</ListInventoryConfiguration>

last updated: 2024-11-12 10:33 UTC - commit: f2c8cfa8c0239917f6ae0d69cf659c61634659c8