PowerScale OneFS API Reference

PDF

Get the WORM properties of a file

Retrieves the WORM retention date and committed state of the file.

Request syntax

GET /namespace/<access_point>/<WORM_directory>/<file_name>?worm HTTP/1.1
Host: <hostname>[:<port>]
Date: <date>
Authorization: <signature>

Request query parameters


Parameter Name	Description	Default	Type	Required
worm	The worm argument must be placed at the first position of the argument list in the URI.	N/A	String	No

Request headers

This call sends common request headers.

Response headers

This call returns common response headers.

Response body

{
   "worm_committed":<boolean>,
   "worm_override_retention_date":<"YYYY-MM-DD hh:mm:ss GMT">|null,
   "worm_override_retention_date_val":<seconds from the Epoch>|null,
   "worm_retention_date":<"YYYY-MM-DD hh:mm:ss GMT">|null,
   "worm_retention_date_val":<seconds from the Epoch>|null
}

Response body parameters


Parameter Name	Description
worm_committed	Indicates whether the file was committed to the WORM state.
worm_retention_date	Provides the retention expiration date in Coordinated Universal Time (such as UTC/GMT). If a value is not specified, the field has a null value.
worm_retention_date_val	Provides the retention expiration date in seconds from UNIX Epoch or UTC.
worm_override_retention_date	Provides the override retention date that is set on the SmartLock directory where the file resides. If the date is not set or is earlier than or equal to the existing file retention date, this field has a null value. Otherwise, the date is expressed in UTC/GMT, and is the retention expiration date for the file if the worm_committed parameter is also set to true.
worm_override_retention_date_val	Provides the override retention date that is set on the SmartLock directory where the file resides. If the date is not set or if the date is set to earlier than or equal to the file retention date, this field has a null value. Otherwise, the date is expressed in seconds from UNIX Epoch and UTC, and is the retention expiration date set for the file if the worm_committed parameter is set to true. This parameter is the same as worm_override_retention_date, but is expressed in seconds from the Epoch or UTC.

Example request

GET /namespace/ifs/dir1/file?worm HTTP/1.1
Host: my_cluster:8080
Date: Tue, 22 May 2012 12:00:00 GMT
Authorization: <signature>

Example response

HTTP/1.1 200 OK
Date: Tue, 22 May 2012 12:00:00 GMT
Content-Length: <length>
Connection: close
Server: Apache2/2.2.19

{
   "worm_committed":true,
   "worm_retention_date":"2013-01-22 15:11:36 GMT",
   "worm_override_retention_date":null,
   "worm_retention_date_val":1358885496,
   "worm_override_retention_date_val":null
}