Bucket:Get Bucket Retention

Search (SHIFT+S)

Get Bucket Retention

GET /object/bucket/{bucketName}/retention

Gets the retention period setting for the specified bucket.

bucketName	Bucket name for which the retention period setting will be retrieved

Query Parameters

namespace	Namespace 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
min_max_governor
enforce_retention		Boolean
minimum_fixed_retention		Long
maximum_fixed_retention		Long
minimum_variable_retention		Long
maximum_variable_retention		Long

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>

Request

GET 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>

Response

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

{
    "period": -2
}

Request

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

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>