Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Bucket Metadata Search Keys

GET /?searchmetadata

Returns the list of system and user metadata keys that are currently being indexed for a bucket. These are the keys that can be used in query expressions for this bucket that will filter the object listings.

URL Format

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

Request Headers

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

  • 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
MetadataSearchList
IndexableKeys a list of metadata keys being used for searches
Key     0-* Elements
Name name of the metadata key String
Datatype data type of the key String
OptionalAttributes
Attribute     0-* Elements
Name name of the metadata attibute String
Datatype data type of the metadata attribute String