Dell Technologies ECS REST API

Search (SHIFT+S)




List Bucket Fanout Objects

GET /?fanout

Returns a list of (up to 1000) fan-out objects and common prefixes(if delimiter is used) in a bucket. Query parameters can be used to return a portion of the objects in a bucket. The result is sorted alphabetically.

URL Format

Host Style: http://bucketname.ns1.emc.com/?fanout
Path Style: http://ns1.emc.com/bucketname?fanout

Request Headers

x-amz-date optionalThe 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 requiredInformation needed to authenticate requests.

Prerequisites

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).


Response Body

Field Description Type Notes
FanoutBucketListingResult
NextFanoutKeyMarker String
NextFanoutIndexMarker Integer
IsTruncated Boolean
FanoutPrefix String
Delimiter String
FanoutObjects     0-* Elements
Key String
Index Integer
FanoutCommonPrefixes     0-* Elements
FanoutPrefix 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