src/ceph/doc/radosgw/s3/commons.rst

   1 =================
   2  Common Entities
   3 =================
   4
   5 .. toctree::
   6    :maxdepth: -1
   7
   8 Bucket and Host Name
   9 --------------------
  10 There are two different modes of accessing the buckets. The first (preferred) method
  11 identifies the bucket as the top-level directory in the URI. ::
  12
  13         GET /mybucket HTTP/1.1
  14         Host: cname.domain.com
  15
  16 The second method identifies the bucket via a virtual bucket host name. For example::
  17
  18         GET / HTTP/1.1
  19         Host: mybucket.cname.domain.com
  20
  21 To configure virtual hosted buckets, you can either set ``rgw_dns_name = cname.domain.com`` in ceph.conf, or add ``cname.domain.com`` to the list of ``hostnames`` in your zonegroup configuration. See `Ceph Object Gateway - Multisite Configuration`_ for more on zonegroups.
  22
  23 .. tip:: We prefer the first method, because the second method requires expensive domain certification and DNS wild cards.
  24
  25 Common Request Headers
  26 ----------------------
  27
  28 +--------------------+------------------------------------------+
  29 | Request Header     | Description                              |
  30 +====================+==========================================+
  31 | ``CONTENT_LENGTH`` | Length of the request body.              |
  32 +--------------------+------------------------------------------+
  33 | ``DATE``           | Request time and date (in UTC).          |
  34 +--------------------+------------------------------------------+
  35 | ``HOST``           | The name of the host server.             |
  36 +--------------------+------------------------------------------+
  37 | ``AUTHORIZATION``  | Authorization token.                     |
  38 +--------------------+------------------------------------------+
  39
  40 Common Response Status
  41 ----------------------
  42
  43 +---------------+-----------------------------------+
  44 | HTTP Status   | Response Code                     |
  45 +===============+===================================+
  46 | ``100``       | Continue                          |
  47 +---------------+-----------------------------------+
  48 | ``200``       | Success                           |
  49 +---------------+-----------------------------------+
  50 | ``201``       | Created                           |
  51 +---------------+-----------------------------------+
  52 | ``202``       | Accepted                          |
  53 +---------------+-----------------------------------+
  54 | ``204``       | NoContent                         |
  55 +---------------+-----------------------------------+
  56 | ``206``       | Partial content                   |
  57 +---------------+-----------------------------------+
  58 | ``304``       | NotModified                       |
  59 +---------------+-----------------------------------+
  60 | ``400``       | InvalidArgument                   |
  61 +---------------+-----------------------------------+
  62 | ``400``       | InvalidDigest                     |
  63 +---------------+-----------------------------------+
  64 | ``400``       | BadDigest                         |
  65 +---------------+-----------------------------------+
  66 | ``400``       | InvalidBucketName                 |
  67 +---------------+-----------------------------------+
  68 | ``400``       | InvalidObjectName                 |
  69 +---------------+-----------------------------------+
  70 | ``400``       | UnresolvableGrantByEmailAddress   |
  71 +---------------+-----------------------------------+
  72 | ``400``       | InvalidPart                       |
  73 +---------------+-----------------------------------+
  74 | ``400``       | InvalidPartOrder                  |
  75 +---------------+-----------------------------------+
  76 | ``400``       | RequestTimeout                    |
  77 +---------------+-----------------------------------+
  78 | ``400``       | EntityTooLarge                    |
  79 +---------------+-----------------------------------+
  80 | ``403``       | AccessDenied                      |
  81 +---------------+-----------------------------------+
  82 | ``403``       | UserSuspended                     |
  83 +---------------+-----------------------------------+
  84 | ``403``       | RequestTimeTooSkewed              |
  85 +---------------+-----------------------------------+
  86 | ``404``       | NoSuchKey                         |
  87 +---------------+-----------------------------------+
  88 | ``404``       | NoSuchBucket                      |
  89 +---------------+-----------------------------------+
  90 | ``404``       | NoSuchUpload                      |
  91 +---------------+-----------------------------------+
  92 | ``405``       | MethodNotAllowed                  |
  93 +---------------+-----------------------------------+
  94 | ``408``       | RequestTimeout                    |
  95 +---------------+-----------------------------------+
  96 | ``409``       | BucketAlreadyExists               |
  97 +---------------+-----------------------------------+
  98 | ``409``       | BucketNotEmpty                    |
  99 +---------------+-----------------------------------+
 100 | ``411``       | MissingContentLength              |
 101 +---------------+-----------------------------------+
 102 | ``412``       | PreconditionFailed                |
 103 +---------------+-----------------------------------+
 104 | ``416``       | InvalidRange                      |
 105 +---------------+-----------------------------------+
 106 | ``422``       | UnprocessableEntity               |
 107 +---------------+-----------------------------------+
 108 | ``500``       | InternalError                     |
 109 +---------------+-----------------------------------+
 110
 111 .. _`Ceph Object Gateway - Multisite Configuration`: ../../multisite