Object Storage API, Amazon S3-compatible REST: ListObjectVersions
Returns metadata for all versions of objects in the bucket.
You can also use request parameters as a selection criterion to return metadata about a subset of object versions.
For more information on getting started with the API and the general request format, see How to use the S3 API.
Request
GET /{bucket}?versions&delimiter=Delimiter&encoding-type=EncodingType&key-marker=KeyMarker&max-keys=MaxKeys&prefix=Prefix&version-id-marker=VersionIdMarker HTTP/2
Path parameters
|
Parameter |
Description |
|
|
Bucket name |
Query parameters
All parameters listed in the table are optional.
|
Parameter |
Description |
|
|
Delimiter character. If this parameter is specified, Object Storage interprets the key as the path to the file with folders separated by the If the request also specifies the |
|
|
Encoding of server responses. Object Storage can encode responses in the format requested by the client. The possible value is |
|
|
Key to start the output from. In the output, Object Storage will leave the keys starting from the one that follows |
|
|
Maximum number of elements in a response. By default, Object Storage outputs no more than 1,000 If the selection criteria are met by more keys than can fit into the output, the response will contain To get all the output elements if their number exceeds |
|
|
String to start the key from. Object Storage selects only those keys which start with Can be used together with |
|
|
Object version to start the output from. In the output, Object Storage will leave the versions starting from the one following |
Headings
Use only common headers in your requests.
Response
Headers
Responses can only contain common headers.
Response codes
For a list of possible responses, see Responses.
A successful response contains additional data in XML format with the schema described below.
Data schema
<?xml version="1.0" encoding="UTF-8"?>
<ListVersionsResult>
<IsTruncated>boolean</IsTruncated>
<KeyMarker>string</KeyMarker>
<VersionIdMarker>string</VersionIdMarker>
<NextKeyMarker>string</NextKeyMarker>
<NextVersionIdMarker>string</NextVersionIdMarker>
<Version>
<ETag>string</ETag>
<IsLatest>boolean</IsLatest>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<Size>integer</Size>
<StorageClass>string</StorageClass>
<VersionId>string</VersionId>
</Version>
...
<DeleteMarker>
<IsLatest>boolean</IsLatest>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<VersionId>string</VersionId>
</DeleteMarker>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
</ListVersionsResult>
|
Element |
Description |
|
|
Root element. |
|
|
Key name part identified when processing the Path: |
|
|
Container for an object that is a delete marker. Path: |
|
|
Value of the Path: |
|
|
Encoding used by Object Storage to provide a key in an XML response. You will get this tag if the client provided the Path: |
|
|
Tag that indicates that a list is incomplete. If Path: |
|
|
Last key returned in the incomplete response. Path: |
|
|
Value of the Path: |
|
|
Bucket name. Path: |
|
|
Value to substitute into the Path: |
|
|
Value to substitute into the Path: |
|
|
Value of the Path: |
|
|
Object version. Path: |
|
|
Marks the last version of the key returned in the truncated response. Path: |