Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Retention Classes

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

Gets the list of retention classes for the specified namespace.

namespaceNamespace identifier for which retention classes 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 class list for the given Namespace

Field Description Type Notes
retention_classes
retention_class     0-* Elements
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 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_classes>
    <retention_class>
        <name>class_9cc8777c-bce0-11e4-8580-0050569c6fd7</name>
        <period>2</period>
    </retention_class>
    <retention_class>
        <name>class_9cc8777d-bce0-11e4-8580-0050569c6fd7</name>
        <period>3</period>
    </retention_class>
    <retention_class>
        <name>class_9e350b48-bce0-11e4-8580-0050569c6fd7</name>
        <period>4</period>
    </retention_class>
    <retention_class>
        <name>class_9e350b49-bce0-11e4-8580-0050569c6fd7</name>
        <period>5</period>
    </retention_class>
    <retention_class>
        <name>class_9fa0b612-bce0-11e4-8580-0050569c6fd7</name>
        <period>6</period>
    </retention_class>
</retention_classes>