Returns a list of (up to 1000) objects in a bucket. Query parameters can be used to return a portion of the objects in a bucket. The result is sorted alphabetically.
Host Style: http://bucketname.ns1.emc.com/
Path Style: http://ns1.emc.com/bucketname
x-amz-date | optional | The timestamp of the request added by the requester. Example: Tue, 03 Sept 2013 12:00:00 GMT. If the Authorization header is specified, you must specify either the x-amz-date or the Date header. If both the headers are specified, the value of x-amz-date header is chosen. |
Authorization | required | Information needed to authenticate requests. |
The following conditions must be met in order to call this operation.
The user must have READ access to the bucket
BaseUrl used in a host-style URL should be pre-configured using the ECS Management API or the ECS Portal (for example, emc.com in URL: bucketname.ns1.emc.com)
Namespace corresponding to this bucket should exist (for example, ns1).
Field | Description | Type | Notes |
ListBucketResult | |||
Name | Name of the bucket | String | |
Prefix | Keys beginning with the indicated prefix. | String | |
Marker | Indicates where to begin listing keys from in the bucket. | String | |
NextMarker | The marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this object listing is truncated | String | |
MaxKeys | The maximum number of keys that will be returned in the response. | Integer | |
Delimiter | This causes the keys containing the same string between the prefix and the first occurrence of the delimiter to be collectively placed into a single result element in CommonPrefixes. Each collection of result counts as only one return against the MaxKeys value | String | |
IsTruncated | Indicates whether all of the objects in the bucket, matching the search criteria, were returned or not. | Boolean |
Valid Values:
|
ServerSideEncryptionEnabled | D@RE Indicates whether the bucket is set for server side encryption. | Boolean |
Valid Values:
|
EncodingType | If ?encoding-type:url was used in a bucket listing, that option must be reflected in the response body | String | |
Contents |
0-* Elements |
||
Key | The key of the object | String | |
LastModified | The date on which the object was last modified. | Date | |
ETag | The entity tag is an MD5 hash of the object. The ETag only indicates the changes to an object | String | |
Size | The size of the object in bytes | Long | |
StorageClass | Storage class | String |
Valid Values:
|
Owner | |||
ID | The ID of the bucket owner | String | |
DisplayName | Screen name of the owner of the bucket. | String | |
CommonPrefixes |
0-* Elements |
||
Prefix | If the request does not include the prefix parameter then this shows only the substring of the key before the first occurrence of the delimiter If the request includes the prefix parameter then this shows the substring of the key from the beginning of the prefix to the first occurrence of the delimiter | String |