Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Policy
- S3 Bucket Versioning
- S3 Bucket Versions
- S3 Data Node
- S3 Metadata Key List
- S3 Metadata Key System List
- S3 Metadata Search
- S3 Multi Object Delete
- S3 Object
- S3 Object ACL
- S3 Object Init Uploads
- S3 Object Replication Info Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- EMC Atmos
- OpenStack Swift
ECS API Changes
List Bucket Objects
GET /
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 |
| 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
| 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 owner | String | |
| DisplayName | Screen name of the owner. | String | |
| IsFanoutObject | The flag indicating if the object is a Fanout Object | Boolean | |
| 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 |