Bucket:Get Bucket Retention

Search (SHIFT+S)




New in this release

Get Bucket Retention

GET /object/bucket/{bucketName}/retention

Gets the retention period setting for the specified bucket.

bucketNameBucket name for which the retention period setting will be retrieved

Query Parameters

namespaceNamespace associated. If it is null, then current user's namespace is used.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Prerequisites

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

  • Bucket name should not be null or empty

  • Bucket must exist.


Response Body

Response contains the default retention period of the bucket

Field Description Type Notes
<default_bucket_retention>
<period> Default retention period for bucket in seconds Long
</default_bucket_retention>

Examples

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

Concept-Type: application/xml 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<default_bucket_retention>
    <period>-2</period>
</default_bucket_retention>
Notes: