EMC Atmos 2.0 Programmer’s Guide

  • View
    1.610

  • Download
    3

Embed Size (px)

Text of EMC Atmos 2.0 Programmer’s Guide

1. EMC AtmosVersion 2.0Programmers GuideP/N 300-012-502REV A01 EMC CorporationCorporate Headquarters: Hopkinton, MA 01748-91031-508-435-1000 www.EMC.com 2. Copyright 2008 - 2011 EMC Corporation. All rights reserved.Published June, 2011EMC believes the information in this publication is accurate as of its publication date. The information issubject to change without notice.THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NOREPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THISPUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.Use, copying, and distribution of any EMC software described in this publication requires an applicablesoftware license.For the most up-to-date regulatory document for your product line, go to the Technical Documentation andAdvisories section on EMC Powerlink.For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.All other trademarks used herein are the property of their respective owners.2 EMC Atmos Version 2.0 Programmers Guide 3. ContentsPrefaceIntroduction ......................................................................................... 8Chapter 1 Getting StartedOverview.............................................................................................. 2Using the object interface................................................................... 4System metadata ................................................................................. 6User metadata...................................................................................... 9Using the namespace interface ....................................................... 14Using checksum protection ............................................................. 20Using the version object API ........................................................... 22Getting better write performance ................................................... 26Chapter 2 Common REST HeadersStandard HTTP headers................................................................... 28Atmos custom headers .................................................................... 31Chapter 3 REST API ReferenceSpecifying objects/files in REST commands ................................44REST commands ............................................................................... 47Creating an object .............................................................................50Creating a version .............................................................................54Deleting an object..............................................................................56Deleting user metadata .................................................................... 58Deleting a version .............................................................................61Getting an ACL .................................................................................63Getting listable tags ..........................................................................65 EMC Atmos Version 2.0 Programmers Guide3 4. ContentsGetting object info............................................................................. 69Getting service information............................................................. 73Getting system metadata ................................................................. 75Getting user metadata...................................................................... 78Listing objects.................................................................................... 82Listing user metadata tags............................................................... 90Listing versions ................................................................................. 92Reading an object.............................................................................. 94Renaming a file or directory in the namespace .......................... 111Restoring a version ......................................................................... 114Setting an ACL ................................................................................ 115Setting user metadata..................................................................... 117Updating an object.......................................................................... 119 Chapter 4SOAP WSDL Schema StructureOverview..........................................................................................124Common elements.......................................................................... 125ACL...................................................................................................126DirectoryEntry ................................................................................ 128DirectoryList.................................................................................... 129ExtentType....................................................................................... 130MetadataTags .................................................................................. 131ObjectEntry ......................................................................................132SystemMetadataEntry.................................................................... 133SystemMetadataList .......................................................................134UserMetadataEntry ........................................................................135UserMetadataList............................................................................136UID.................................................................................................... 137 Chapter 5SOAP API ReferenceOverview..........................................................................................140Creating an object ...........................................................................141Deleting an object ...........................................................................144Deleting user metadata .................................................................. 146Getting an ACL ...............................................................................148Getting listable tags ........................................................................150Getting system metadata ............................................................... 153Getting user metadata.................................................................... 158Listing objects.................................................................................. 160Listing user metadata tags............................................................. 164Reading an object............................................................................ 1664EMC Atmos Version 2.0 Programmers Guide 5. ContentsRenaming a file or directory in the namespace .......................... 177Setting an ACL................................................................................. 179Setting user metadata ..................................................................... 181Updating an object .......................................................................... 183Chapter 6 SecurityOverview .......................................................................................... 188Managing authentication ............................................................... 189REST authentication: algorithm for securing REST messages withsignatures ......................................................................................... 190SOAP authentication ...................................................................... 194Access Control Lists........................................................................ 196Shareable URLs................................................................................ 198Chapter 7 Reserved Namespace for Extended AttributesOverview .......................................................................................... 202Linux extended attributes .............................................................. 203Atmos extended attributes............................................................. 204Chapter 8 Error Messages and Status CodesREST information ............................................................................ 212SOAP information........................................................................... 213Error codes ....................................................................................... 214IndexEMC Atmos Version 2.0 Programmers Guide 5 6. Contents6EMC Atmos Version 2.0 Programmers Guide 7. PrefaceAs part of an effort to improve and enhance the performance and capabilitiesof its product lines, EMC periodically releases revisions of its hardware andsoftware. Therefore, some functions described in this document may not besupported by all versions of the software or hardware currently in use. Forthe most up-to-date information on product features, refer to your productrelease notes.If a product does not function properly or does not function as described inthis document, please contact your EMC representative.Note: This document was accurate as of the time of publication. However, asinformation is added, new versions of this document may be released to theEMC Powerlink website. Check the Powerlink website to ensure that you areusing the latest version of this document.Preface 7 8. PrefaceIntroductionAudience This document is part of the Atmos documentation set, and is intended for use by system administrators who are responsible for installing, configuring, and maintaining Atmos. Related The EMC Atmos documentation set also includes the following titles:documentation EMC Atmos Release Notes EMC Atmos Administrators Guide EMC Atmos Programmers Guide EMC Atmos System Management API Guide EMC Atmos Security Configuration Guide EMC Atmos Non-EMC Software License Agreements EMC