| Parameter | Type | Default Value | Description |
|---|---|---|---|
query |
string | [no filter] | The TinyQ language filter that specifies a subset of all available records. |
field |
string | not present | The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values, |
page |
integer | 1 | The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize. |
pagesize |
integer | [unlimited] | The maximum number of object records to return as a result of the request. |
| Object type: page | |
|---|---|
| A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing. | |
| Field | Description |
| next | A URL addressing the subsequent page of objects in the total set of available objects. |
| objects | The list of objects returned in the page of results. |
| prev | A URL addressing the previous page of objects in the total set of available objects. |
| Object type: disk-usage | |
|---|---|
| A DiskUsage object contains information about disk usage by a Sentinel system. | |
| Field | Description |
| avail | The amount of free disk space in kilobytes. |
| capacity-at-risk | If true, the disk storage is at risk of running out of available space. |
| capacity-at-risk-start-time | The date and time at which the disk storage reached the "at-risk" threshold. |
| days | The number of days included in the historical disk usage data. |
| hist | A list of HistoricalDiskUsage objects that describe the history of disk space consumption in the Sentinel system. Definition |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| overflow-start | The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space. |
| overflow-stop | The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage. |
| rate | The average rate (in kilobytes) of disk usage. |
| total | The total disk space available in kilobytes. |
| type | The type of disk storage to which the DiskUsage object's data applies. |
| used | The amount of disk space used in kilobytes. |
| Object type: meta | |
|---|---|
| The metadata for an object, including the object type name and the URL reference to the object. | |
| Field | Description |
| @href | The URL reference to the object. |
| type | The name of the object type |
| Object type: hist-disk-usage | |
|---|---|
| A HistoricalDiskUsage system object contains the amount of disk space consumed on a particular day. | |
| Field | Description |
| date | The date on which the disk space was consumed. |
| used | The amount of disk space consumed (in kilobytes). |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage?page=2&pagesize=1
{
"objects":[
{
"meta":{
"type":"disk-usage",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage/LOCAL"
},
"capacity-at-risk-start-time":"2012-04-25T13:33:44.617Z",
"total":62700920,
"overflow-stop":42,
"rate":"44316.819967999996",
"days":7,
"overflow-start":90,
"hist":[
{
"date":"2012-04-25T13:33:44.617Z",
"used":4840
}
],
"capacity-at-risk":false,
"avail":56197572,
"used":6503348,
"type":"LOCAL"
}
],
"prev":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage?pagesize=1&page=1"
},
"next":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage?pagesize=1&page=3"
}
}
| Object type: disk-usage | ||
|---|---|---|
| A DiskUsage object contains information about disk usage by a Sentinel system. | ||
| Field | Required | Description |
| overflow-start | false | The percent value of total space that, when reached, will cause Sentinel to begin moving data to secondary storage in order to create free space. |
| overflow-stop | false | The percent value of total space that, when reached, will cause Sentinel to stop moving data to secondary storage. |
| type | true | The type of disk storage to which the DiskUsage object's data applies. |
| Object type: meta | ||
|---|---|---|
| The metadata for an object, including the object type name and the URL reference to the object. | ||
| Field | Required | Description |
| @href | false | The URL reference to the object. |
| type | false | The name of the object type |
| Object type: | |
|---|---|
| The metadata representation of the newly-created disk-usage object, including the URL reference to the new object. | |
| Field | Description |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| Object type: meta | |
|---|---|
| The metadata for an object, including the object type name and the URL reference to the object. | |
| Field | Description |
| @href | The URL reference to the object. |
| type | The name of the object type |
| Object type: hist-disk-usage | |
|---|---|
| A HistoricalDiskUsage system object contains the amount of disk space consumed on a particular day. | |
| Field | Description |
| date | The date on which the disk space was consumed. |
| used | The amount of disk space consumed (in kilobytes). |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage
{
"overflow-stop":42,
"overflow-start":90,
"type":"LOCAL"
}
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage/Wildebeest
{
"meta":{
"type":"disk-usage",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/disk-usage/Wildebeest"
}
}