Dell Technologies ECS REST API
Search (SHIFT+S)
ECS Management API
ECS Object Service API
ECS API Changes

Get Zone

GET /dashboard/zones/{id}

Gets the hosted VDC details.

idZone identifier

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN

Response Body

Hosted VDC details

Examples

Request
GET https://192.168.0.0:4443/dashboard/zones/{id} HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/json

{
  "title" : "zones List",
  "_links" : {
    "self" : {
      "href" : "/dashboard/zones/urn:storageos:VirtualDataCenterData:3cd18c03-68e0-4b01-89e5-68fddd1b03fd"
    }
  },
  "_embedded" : {
    "_instances" : [ {
      "_links" : {
        "self" : {
          "href" : "/dashboard/zones/urn:storageos:VirtualDataCenterData:3cd18c03-68e0-4b01-89e5-68fddd1b03fd"
        }
      },
      "apiChange" : "1",
      "name" : "VDC3",
      "id" : "urn:storageos:VirtualDataCenterData:3cd18c03-68e0-4b01-89e5-68fddd1b03fd",
      "type" : "Hosted",
      "transactionWriteBandwidthCurrent" : [ {
        "t" : "1502743500",
        "Bandwidth" : "828.9533333333334"
      }, {
        "t" : "1502743800",
        "Bandwidth" : "355.1666666666667"
      } ],
      "transactionReadLatencyCurrent" : [ {
        "t" : "1502743500",
        "Latency" : "0.0"
      }, {
        "t" : "1502743800",
        "Latency" : "0.0"
      } ],
      "transactionWriteLatencyCurrent" : [ {
        "t" : "1502743500",
        "Latency" : "31.0"
      }, {
        "t" : "1502743800",
        "Latency" : "46.0"
      } ],
      "transactionReadBandwidthCurrent" : [ {
        "t" : "1502743500",
        "Bandwidth" : "593.5866666666667"
      }, {
        "t" : "1502743800",
        "Bandwidth" : "279.73333333333335"
      } ]
    } ]
  }
}

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
------------------------------------+-----------+-------------------------------------------------------------------+------------
title                               |           |        |Name of resource                                          |
------------------------------------+-----------+-------------------------------------------------------------------+------------
url.self                            |           |        |URL to this resource                                      |
------------------------------------+-----------+-------------------------------------------------------------------+------------
id                                  |           |        |ID of the Zone                                            |
------------------------------------+-----------+-------------------------------------------------------------------+------------
name                                |           |        |Name of the Zone                                          |
------------------------------------+-----------+-------------------------------------------------------------------+------------
type                                |           |        |Type of the Zone: Hosted, On-Premises                     |
------------------------------------+-----------+-------------------------------------------------------------------+------------
transactionReadBandwidth            |           |        |Read bandwidth of cloud VDC (Zone)                        |Bytes/Second
------------------------------------+-----------+-------------------------------------------------------------------+------------
transactionWriteBandwidth           |           |        |Write bandwidth of cloud VDC (Zone)                       |Bytes/Second
------------------------------------+-----------+-------------------------------------------------------------------+------------
transactionReadLatency              |           |        |Read latency of cloud VDC (Zone)                          |Milliseconds
------------------------------------+-----------+-------------------------------------------------------------------+------------
transactionWriteLatency             |           |        |Write latency of cloud VDC (Zone)                         |Milliseconds
------------------------------------+-----------+-------------------------------------------------------------------+------------
Dell Technologies ECS REST API v3.8.0.2.138627.f5f4887