ListObjectVersions
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. S3 interface for MSDP recommends using this API with 1000 max keys and object name as a prefix to list all object versions in one request.
Request Syntax
GET /bucket/?versions&delimiter=Delimiter&key-marker= KeyMarker&max-keys=MaxKeys&prefix=Prefix HTTP/1.1 Host: msdps3.server:8443
Or
GET /bucket/?versions&delimiter=Delimiter&max-keys= MaxKeys&prefix=Prefix&version-id-marker=VersionIdMarker HTTP/1.1 Host: msdps3.server:8443
Request Parameters
Bucket
Name of the bucket that contains the objects.
Required: Yes
Type: String
key-marker
The value of NextKeyMarker of response should be used in request as marker. The marker can only be used once and valid for two minutes by default. This parameter can only be used with version-id-marker.
Type: String
delimiter
A delimiter is a character used to group keys. It rolls up the keys that contain the same character between the prefix and the first occurrence of the delimiter into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value. MSDP S3 supports only "/" string as delimiter.
Type: String
max-keys
Limits the number of keys returned in the response. By default, the action returns up to 1,000 key names.
Type: Integer
prefix
Limits the response to keys that begin with the specified prefix.
Type: String
version-id-marker
The value of NextVerionIDMarker of response should be used in request as VersionIdMarker. The marker can only be used once and valid for two minutes by default. This parameter can only be used with key-marker.
Type: String
Response Syntax
HTTP/1.1 200
<?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>
<Size>integer</Size>
<StorageClass>string</StorageClass>
<VersionId>string</VersionId>
</Version>
...
<DeleteMarker>
<IsLatest>boolean</IsLatest>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<VersionId>string</VersionId>
</DeleteMarker>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
</ListVersionsResult>>Response Body
ListVersionsResult
Root level tag for the ListVersionsResult parameters.
Required: Yes
DeleteMarker
Metadata about each delete marker. Response can have zero or more delete markers.
Contents
Metadata about each object that is returned.
IsLatest
Specify if the object is latest.
Type: Boolean
Key
Delete marker name.
LastModified
Last modification date and time of the delete marker.
Type: Timestamp
VersionId
Specify version ID of the delete marker.
Delimiter
Delimiter value that is passed in the request.
IsTruncated
A flag indicating whether all the results satisfying the search criteria were returned by MSDP S3.
KeyMarker
The value of NextKeyMarker of response should be used in request as KeyMarker.
MaxKeys
The maximum number of objects that can be returned in the response body.
Name
The name of the bucket.
NextKeyMarker
When the response is truncated, you can use this value as KeyMarker in subsequent request to get next set of objects.
NextVersionIdMarker
When the response is truncated, you can use this value as VersionIdMarker in subsequent request to get next set of objects.
Prefix
Limits the response to keys that begin with the specified prefix.
VersionIdMarker
The value of NextVersionIdMarker of response should be used in request as VersionIdMarker.
Version
Metadata about object version.
ETag
SHA256 digest of the object.
IsLatest
Specify if the object is latest.
Type: Boolean
Key
Object name.
LastModified
Last modification date and time of the object.
DELETE /bucket/Key+?uploadId=UploadId HTTP/1.1
Size of the object.
StorageClass
Storage class of the object.
VersionId
Specify version ID of the object.
Recommend less than 1000 CommonPrefixes elements under a specified prefix that is separated by the slash (/) delimiter character. If more than 10000 CommonPrefixes elements under a specified prefix exist, list objects with the prefix and the delimiter parameters in the request returns only 10000 elements. You can use list objects without delimiter if you want to list all elements under a specified prefix.
Possible Error Response
Success
HTTP status code 200.
InvalidArgument(continuation token is invalid)
Invalid Argument. HTTP status code 400.
InvalidArgument(maxKeys is invalid)
Invalid Argument.
HTTP status code 400.
S3srvExtInvalidPrefix
Prefixes cannot start with a slash.
HTTP status code 400.
S3srvExtInvalidDelimiter
Only support the slash as a delimiter.
HTTP status code 400
S3srvExtInvalidKeyMarker
The key marker is invalid.
HTTP status code 400
AccessDenied
Access Denied.
HTTP status code 403.
NoSuchBucket
The specified bucket does not exist.
HTTP status code 404.
InternalError
Request failed because of an internal server error.
HTTP status code 500.