ceph/doc/radosgw/s3.rst

   1 ============================
   2  Ceph Object Gateway S3 API
   3 ============================
   4
   5 Ceph supports a RESTful API that is compatible with the basic data access model of the `Amazon S3 API`_.
   6
   7 API
   8 ---
   9
  10 .. toctree::
  11    :maxdepth: 1
  12
  13    Common <s3/commons>
  14    Authentication <s3/authentication>
  15    Service Ops <s3/serviceops>
  16    Bucket Ops <s3/bucketops>
  17    Object Ops <s3/objectops>
  18    C++ <s3/cpp>
  19    C# <s3/csharp>
  20    Java <s3/java>
  21    Perl <s3/perl>
  22    PHP <s3/php>
  23    Python <s3/python>
  24    Ruby <s3/ruby>
  25
  26
  27 Features Support
  28 ----------------
  29
  30 The following table describes the support status for current Amazon S3 functional features:
  31
  32 +---------------------------------+-----------------+----------------------------------------+
  33 | Feature                         | Status          | Remarks                                |
  34 +=================================+=================+========================================+
  35 | **List Buckets**                | Supported       |                                        |
  36 +---------------------------------+-----------------+----------------------------------------+
  37 | **Delete Bucket**               | Supported       |                                        |
  38 +---------------------------------+-----------------+----------------------------------------+
  39 | **Create Bucket**               | Supported       | Different set of canned ACLs           |
  40 +---------------------------------+-----------------+----------------------------------------+
  41 | **Bucket Lifecycle**            | Supported       |                                        |
  42 +---------------------------------+-----------------+----------------------------------------+
  43 | **Policy (Buckets, Objects)**   | Supported       | ACLs & bucket policies are supported   |
  44 +---------------------------------+-----------------+----------------------------------------+
  45 | **Bucket Website**              | Supported       |                                        |
  46 +---------------------------------+-----------------+----------------------------------------+
  47 | **Bucket ACLs (Get, Put)**      | Supported       | Different set of canned ACLs           |
  48 +---------------------------------+-----------------+----------------------------------------+
  49 | **Bucket Location**             | Supported       |                                        |
  50 +---------------------------------+-----------------+----------------------------------------+
  51 | **Bucket Notification**         | Supported       | See `S3 Notification Compatibility`_   |
  52 +---------------------------------+-----------------+----------------------------------------+
  53 | **Bucket Object Versions**      | Supported       |                                        |
  54 +---------------------------------+-----------------+----------------------------------------+
  55 | **Get Bucket Info (HEAD)**      | Supported       |                                        |
  56 +---------------------------------+-----------------+----------------------------------------+
  57 | **Bucket Request Payment**      | Supported       |                                        |
  58 +---------------------------------+-----------------+----------------------------------------+
  59 | **Put Object**                  | Supported       |                                        |
  60 +---------------------------------+-----------------+----------------------------------------+
  61 | **Delete Object**               | Supported       |                                        |
  62 +---------------------------------+-----------------+----------------------------------------+
  63 | **Get Object**                  | Supported       |                                        |
  64 +---------------------------------+-----------------+----------------------------------------+
  65 | **Object ACLs (Get, Put)**      | Supported       |                                        |
  66 +---------------------------------+-----------------+----------------------------------------+
  67 | **Get Object Info (HEAD)**      | Supported       |                                        |
  68 +---------------------------------+-----------------+----------------------------------------+
  69 | **POST Object**                 | Supported       |                                        |
  70 +---------------------------------+-----------------+----------------------------------------+
  71 | **Copy Object**                 | Supported       |                                        |
  72 +---------------------------------+-----------------+----------------------------------------+
  73 | **Multipart Uploads**           | Supported       |                                        |
  74 +---------------------------------+-----------------+----------------------------------------+
  75 | **Object Tagging**              | Supported       | See :ref:`tag_policy` for Policy verbs |
  76 +---------------------------------+-----------------+----------------------------------------+
  77 | **Bucket Tagging**              | Supported       |                                        |
  78 +---------------------------------+-----------------+----------------------------------------+
  79 | **Storage Class**               | Supported       | See :ref:`storage_classes`             |
  80 +---------------------------------+-----------------+----------------------------------------+
  81
  82 Unsupported Header Fields
  83 -------------------------
  84
  85 The following common request header fields are not supported:
  86
  87 +----------------------------+------------+
  88 | Name                       | Type       |
  89 +============================+============+
  90 | **x-amz-security-token**   | Request    |
  91 +----------------------------+------------+
  92 | **Server**                 | Response   |
  93 +----------------------------+------------+
  94 | **x-amz-delete-marker**    | Response   |
  95 +----------------------------+------------+
  96 | **x-amz-id-2**             | Response   |
  97 +----------------------------+------------+
  98 | **x-amz-version-id**       | Response   |
  99 +----------------------------+------------+
 100
 101 .. _Amazon S3 API: http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html
 102 .. _S3 Notification Compatibility: ../s3-notification-compatibility