• Bucket

Set Bucket Retention

Updates the default retention period setting for the specified bucket.

Required Roles

• SYSTEM_ADMIN

Prerequisites

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

• Bucket name should not be null or empty.

• Bucket must exist.

Request Payload

<default_bucket_retention_update>
   <period></period>
   <namespace></namespace>
   <min_max_governor>
      <enforce_retention></enforce_retention>
      <minimum_fixed_retention></minimum_fixed_retention>
      <maximum_fixed_retention></maximum_fixed_retention>
      <minimum_variable_retention></minimum_variable_retention>
      <maximum_variable_retention></maximum_variable_retention>
   </min_max_governor>
</default_bucket_retention_update>

{
  "period": "",
  "namespace": "",
  "min_max_governor": {
    "enforce_retention": "",
    "minimum_fixed_retention": "",
    "maximum_fixed_retention": "",
    "minimum_variable_retention": "",
    "maximum_variable_retention": ""
  }
}

Response Body

Response indicating Success or Failure of the operation

Examples

PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/retention: HTTP/1.1

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

<default_bucket_retention_update>
   <period>3</period>
   <namespace>s3</namespace>
</default_bucket_retention_update>

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

PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/retention.json HTTP/1.1

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

{
  "default_bucket_retention_update": {
    "period": "3",
    "namespace": "s3"
  }
}

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

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

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