Bucket:Update Bucket Is Stale Allowed

Search (SHIFT+S)

Update Bucket Is Stale Allowed

POST /object/bucket/{bucketName}/isstaleallowed

Updates isStaleAllowed details for the specified bucket in order to enable access to the bucket during a temporary site outage. If namespace does not exist in the request payload, the current user's namespace is used.

If you set this flag ON, and a temporary site outage occurs, objects that you access in this bucket might have been updated at the failed site but changes might not have been propagated to the site from which you are accessing the object.Hence, you are prepared to accept that the objects you read might not be up to date.

If the flag is turned OFF, data in the zone which has the temporary outage is not available for access from other zones and object reads for data which has its primary in the failed site will fail.

bucketName	Name of the bucket for which isStaleAllowed is to be updated

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
NAMESPACE_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

Bucket must exist.

Request Payload

<object_bucket_update_is_stale_allowed>
   <is_stale_allowed></is_stale_allowed>
   <namespace></namespace>
</object_bucket_update_is_stale_allowed>

{
  "is_stale_allowed": "",
  "namespace": ""
}

All parameters are required unless otherwise stated.

Field	Description	Type	Notes
object_bucket_update_is_stale_allowed
is_stale_allowed	isStaleAllowed flag of the bucket	String	Valid Values: True False
namespace	Namespace associated with the user/tenant that is allowed to access the bucket	String

Response Body

Response indicating Success or Failure of the operation

Examples

Request

POST https://192.168.0.0:4443/object/bucket/standalone-bucket/isstaleallowed HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<object_bucket_update_is_stale_allowed>
   <is_stale_allowed>false</is_stale_allowed>
   <namespace>s3</namespace>
</object_bucket_update_is_stale_allowed>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

Request

POST https://192.168.0.0:4443/object/bucket/standalone-bucket/isstaleallowed.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

{
  "is_stale_allowed": "false",
  "namespace": "s3"
}

Response

HTTP/1.1 200 OK
Content-Type: application/json

Request

curl -H $token -H "Content-Type: application/xml" -X POST https://$nodeIp:4443/object/bucket/standalone-bucket/isstaleallowed

Response

HTTP/1.1 200 OK
Content-Type: application/xml