From a1ba3852cc9475c6b5595728df14b7f4fa12727b Mon Sep 17 00:00:00 2001 From: Abhishek Lekshmanan Date: Mon, 24 Nov 2014 22:57:44 +0530 Subject: [PATCH] doc: rgw document s3 bucket location features Fixes: #10142 Reported-by: Neil Levine Signed-off-by: Abhishek Lekshmanan --- doc/radosgw/s3.rst | 2 +- doc/radosgw/s3/bucketops.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/doc/radosgw/s3.rst b/doc/radosgw/s3.rst index e925872d6c22b..fe975e6b9667e 100644 --- a/doc/radosgw/s3.rst +++ b/doc/radosgw/s3.rst @@ -46,7 +46,7 @@ The following table describes the support status for current Amazon S3 functiona +---------------------------------+-----------------+----------------------------------------+ | **Bucket ACLs (Get, Put)** | Supported | Different set of canned ACLs | +---------------------------------+-----------------+----------------------------------------+ -| **Bucket Location** | Not Supported | | +| **Bucket Location** | Supported | | +---------------------------------+-----------------+----------------------------------------+ | **Bucket Notification** | Not Supported | | +---------------------------------+-----------------+----------------------------------------+ diff --git a/doc/radosgw/s3/bucketops.rst b/doc/radosgw/s3/bucketops.rst index ed089789c62ca..f066005ab24be 100644 --- a/doc/radosgw/s3/bucketops.rst +++ b/doc/radosgw/s3/bucketops.rst @@ -157,6 +157,34 @@ The ``ListBucketResult`` contains objects, where each object is within a ``Conte | ``StorageClass`` | String | Should always return ``STANDARD``. | +------------------------+-----------+------------------------------------------+ +Get Bucket Location +------------------- +Retrieves the bucket's region. The user needs to be the bucket owner +to call this. A bucket can be constrained to a region by providing +``LocationConstraint`` during a PUT request. + +Syntax +~~~~~~ +Add the ``location`` subresource to bucket resource as shown below + +:: + + GET /{bucket}?location HTTP/1.1 + Host: cname.domain.com + + Authorization: AWS {access-key}:{hash-of-header-and-secret} + +Response Entities +~~~~~~~~~~~~~~~~~~~~~~~~ + ++------------------------+-----------+------------------------------------------+ +| Name | Type | Description | ++========================+===========+==========================================+ +| ``LocationConstraint`` | String | The region where bucket resides, empty | +| | | string for defult region | ++------------------------+-----------+------------------------------------------+ + + Get Bucket ACL -------------- -- 2.39.5