Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Retention Class

GET /object/namespaces/namespace/{namespace}/retention/{class}

Gets the retention period for the given namespace and retention class.

namespaceNamespace for which retention period needs to retrieved
classClass name for which retention period needs to retrieved

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR

  • NAMESPACE_ADMIN


Prerequisites

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

  • Namespace must exist


Response Body

Retention period for the given namespace and retention class

Field Description Type Notes
retention_class
name Name of the retention class String
period Period of the retention class in seconds Long

Examples

Request
GET https://192.168.0.0:4443/object/namespaces/namespace/s3/retention/class_9cc8777c-bce0-11e4-8580-0050569c6fd7 HTTP/1.1
Content-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"?>
<retention_class>
    <name>class_9cc8777c-bce0-11e4-8580-0050569c6fd7</name>
    <period>2</period>
</retention_class>