S3 Metadata Search:Get Objects List

Search (SHIFT+S)

Get Objects List

GET /?query={expression}&attributes={name, ...}&sorted={key}&include-older-versions={true|false}

Executes a bucket search and returns list of objects, and their system and user metadata values, that match the selection conditions in the search query expression.

The objects returned can be restricted using the max-keys parameter. Where a subset of the search matches are returned, subsequent pages can be retrieved by using the marker from the previous search; the objects returned will start with the key after the marker.

Query Parameters

query (required) is an expression takes the form: [(]{condition1}[%20[and/or]%20{condition2}][)][%20[and/or]%20...]

where:

condition is a metadata keyname filter in the form: {selector} {operator} {argument}, for example "LastModified>2015-01-01T00:00:00Z"

in which:

selector is a searchable keyname associated with the bucket
operator is one of: ==, >, <, >=, <=
argument is a value against which the selector is tested. The form of the argument must match the datatype of the key being indexed, which is one of: string, integer, datetime, decimal

attributes (optional) is a list one or more metadata names that are not being indexed, but which can be listed in the query results. For example: "&attributes=ContentType,Retention"

sorted (optional) is the name of one key that appears in the query expression that becomes the sort key for the query results. If this optional parameter is absent, the sort order is the first keyname that appears in the expression.

include-older-versions (optional) is a boolean that when set to true causes both current and non-current versions of the keys to be listed, and when set to false causes only the current versions of keys to be listed. The default is false.

max-keys (optional) specifies the number of keys returned in the response body. Allows you to return fewer keys that the default.

marker (optional) specifies the key to start with which will be the one after the marker. When no more pages exist, a marker will not be returned and NO MORE PAGES will be returned

URL Format

Host Style: http://bucketname.ns1.emc.com/?query={expression}&attributes={name, ...}&sorted={key}&include-older-versions={true|false}
Path Style: http://ns1.emc.com/bucketname/?query={expression}&attributes={name, ...}&sorted={key}&include-older-versions={true|false}

Request Headers

x-amz-date	optional	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.

BaseUrl used in a host-style request URL should be pre-configured using the ECS Management API or the ECS Portal (for example, emc.com in URL: bucketname.ns1.emc.com).

Response Body

Response indicating Success or Failure for this operation

Field	Description	Type	Notes
BucketQueryResult
Name	Name of the bucket	String
NextMarker	The marker to use in order to request the next page of results	String
IsTruncated	Indicates whether all of the objects in the bucket, matching the search criteria, were returned or not.	Boolean	Valid Values: Boolean value : true or false
MaxKeys	The maximum number of keys that will be returned in the response.	Integer
ObjectMatches	Container for matched records list
object			0-* Elements
objectName		String
objectId		String
versionId		String
objectOwnerZone		String
queryMds			0-* Elements
type
mdMap		Map
queryBinaryMds			0-* Elements
left		L
right		R
indexKey
isFanoutObject		Boolean
CommonPrefixMatches
PrefixGroups		String	0-* Elements