• S3 Bucket

List Bucket Objects

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.

URL Format

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

---

Query Parameters

list-type	Query list-type 0 1 String Indicate the request is V2 API request by setting its value to 2. Otherwise, the request will be treated as v1 request.
continuation-token	Query continuation-token 0 1 String V2 Indicate an opaque value that ECS S3 understands and can start listing from with this value.
delimiter	Query delimiter 0 1 String A character used to group keys (object names). CommonPrefixes result element is returned which has the keys containing the same string between the prefix and the first occurrence of the delimiter. If prefix is not specified, the substring will start at the beginning of the key.
encoding-type	Query encoding-type 0 1 String V2 Requests to encode the response and specifies the encoding method to use.
fetch-owner	Query fetch-owner 0 1 String V2 listing API does not return the Owner information in the response. If you want the owner information in the response, you can specify this parameter with the value set to true.
marker	Query marker 0 1 String Indicates the key to begin listing from.
max-keys	Query max-keys 0 1 String The maximum number of keys that are returned in the response.If the number of keys satisfying the search criteria are more than max-keys, the response contains true. The default value is 1000.
prefix	Query prefix 0 1 String Only keys beginning with the specified prefix are returned in the response.
start-after	Query start-after 0 1 String V2 Return key names after this specific object key in your key space, you can add this parameter. This parameter is valid only in your first request. In case the response is truncated, you can specify this parameter along with the continuation-token parameter, and then ECS S3 will ignore this parameter.

Request Headers

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.

---

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