Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Empty Status Operations
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Fanout (Cloud DVR)
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Lock Configuration Operations
- S3 Bucket Object Lock Operations
- S3 Bucket Policy
- S3 Bucket Versioning
- S3 Bucket Versions
- S3 Data Node
- S3 Metadata Key List
- S3 Metadata Key System List
- S3 Metadata Search
- S3 Multi Object Delete
- S3 Object
- S3 Object ACL
- S3 Object Detailed Replication Status Operations
- S3 Object Init Uploads
- S3 Object Legal Hold Operations
- S3 Object Replication Info Operations
- S3 Object Retention Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- S3 Select Operations
- EMC Atmos
- OpenStack Swift
ECS API Changes
Get Disk
GET /dashboard/disks/{id}
Gets the disk instance details.
| id | Disk identifier |
Required Roles
Requires one of the following roles:
SYSTEM_MONITOR
SYSTEM_ADMIN
Response Body
Disk instance details.
Examples
Request
GET https://192.168.0.0:4443/dashboard/disks/disk-id HTTP/1.1 Content-Type: application/json X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"_links": {
"self": { "href": "/dashboard/disks/{disk-id}"}
},
"apiChange" : "1",
"id": "disk-id",
"displayName": disk-id,
"healthStatus": "Good"
"diskSpaceTotal": [ {"t":"12345678" , "Space":500}, {"t":"23435455" , " Space ":500}, {"t":"55433455" , " Space ":500}],
"diskSpaceFree": [ {"t":"12345678" , "Space":100}, {"t":"23435455" , " Space ":100}, {"t":"55433455" , " Space ":50}],
"diskSpaceAllocated": [ {"t":"12345678" , "Space":400}, {"t":"23435455" , " Space ":400}, {"t":"55433455" , " Space ":450}],
"diskSpaceAllocatedL1" : [ { "t" : "1502322826", "Space" : "44217988320" } ],
"diskSpaceAllocatedL2" : [ { "t" : "1502322582", "Space" : "59861049600" } ],
"diskSpaceAllocatedPercentage" : [ { "t" : "1502322582", "Percent" : "1.3010893632101532" } ],
"diskSpaceFreeL1" : [ { "t" : "1502322826", "Space" : "7547002489760" } ],
"diskSpaceFreeL2" : [ { "t" : "1502322582", "Space" : "348295061120" } ],
"nodeDisplayName" : "boston-raspberry",
"nodeId" : "69721eed-3cae-4bf3-88c7-8719a9273af1",
"slotId" : "1",
"ssmL1Status" : "Good(PD UP)",
"ssmL2Status" : "Good(PD UP)",
"storagePoolId" : "b40efcb6-8392-4f51-b965-8b12c9ba6a24",
"storagePoolName" : "SP2",
}
ATTRIBUTES DESCRIPTION
======================
a. All Time Stamps are GMT Epoch time in seconds.
b. Numbers can be reported in different formats, including without decimal point (e.g. 23000000), with decimal point
(23000000.0) or exponential (2.3e7)
c. <Attribute>Current: The most recent value of an attribute. The attribute is returned in the form of a single snapshot
{"t":12345678, " 'value tag' ":10} where 'value tag' reports the most recently known value of the attribute
and timestamp 't' reports time for which this value is available. The value tag is the same as used for the original
historical attribute. Units of the reported current value are the same as units of the corresponding historical attribute.
d. <Attribute>Summary: (Historical attributes only) The summary values for a historical attribute which includes
Min (lowest), Max (highest) and Avg (average) values across all snapshots. The attribute is returned in the form of
{"Min": {"t":"12345678", "Percent":10}, "Max": {"t":"23435455", "Percent": "43"}, "Avg": "30.67" }.
The value tag is the same as used for the original historical attribute. Units of the reported current value are the
same as units of the corresponding historical attribute.
e. 'dataType' filter: The client can use this filter to indicate which data needs to be returned in the feed. If not supplied,
both current and historical data will be returned.
dataType=current: return only the Current values, as detailed in Point C.
dataType=historical&startTime=<Time>&endTime=<Time>&interval=<Interval in seconds>: return historical series data
and summary for the period specified. Start and End Times are in Epoch Time in Seconds.
f. 'category' filter: Every API can be called with an optional 'category' filter. This filter specifies the category of
data to be included in the API. It is recommended to use filters only when a subset of the attributes is necessary.
g. Starting from ECS 2.2 a new attribute named "apiChange' is returned. This attribute may be removed in future versions
of the API, and currently always has the value "1".
------------------------------------+-----------+--------+----------------------------------------------------------+----------
Attribute |Historical?|Category| Description |Units
------------------------------------+-----------+--------+----------------------------------------------------------+----------
url.self | | | URL to this resource |
------------------------------------+-----------+-------------------------------------------------------------------+----------
id | | | id of the disk |
------------------------------------+-----------+-------------------------------------------------------------------+----------
displayName | | | Name of the disk |
------------------------------------+-----------+-------------------------------------------------------------------+----------
healthStatus | | | Disk health status: Good, NotAccessible, Suspect, Bad, |
| | | Removed, Missing, Maintenance |
------------------------------------+-----------+-------------------------------------------------------------------+----------
nodeDisplayName | | |Name of the node |
------------------------------------+-----------+-------------------------------------------------------------------+----------
nodeId | | |ID of the node |
------------------------------------+-----------+-------------------------------------------------------------------+----------
slotId | | |ID of the disk slot |
------------------------------------+-----------+-------------------------------------------------------------------+----------
ssmL1Status | | |L1 disk status as reported by Storage Server Manager (SSM)|
------------------------------------+-----------+-------------------------------------------------------------------+----------
ssmL2Status | | |L2 disk status as reported by Storage Server Manager (SSM)|
------------------------------------+-----------+-------------------------------------------------------------------+----------
storagePoolId | | |ID of the StoragePool |
------------------------------------+-----------+-------------------------------------------------------------------+----------
storagePoolName | | |Name of the StoragePool |
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceAllocated |historical |capacity|Total usable space on the disk |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceAllocatedL1 |historical |capacity|Space allocated for chunks on the disk(s) for L1 |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceAllocatedL2 |historical |capacity|Space allocated for chunks on the disk(s) for L2 |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceAllocatedPercentage |historical |capacity|Total allocated space over total usable space on disk(s) |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceFree |historical |capacity|Total free usable disk space of disk(s) if status is Good |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceFreeL1 |historical |capacity|Level 1 usable disk space |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceFreeL2 |historical |capacity|Level 2 usable disk space |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------
diskSpaceTotal |historical |capacity|Total usable space on the disk(s) |Bytes
------------------------------------+-----------+-------------------------------------------------------------------+----------