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

Get Local Zone Replication Groups

GET /dashboard/zones/localzone/replicationgroups

Gets the local VDC replication groups details.

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR

  • SYSTEM_ADMIN

Response Body

Local VDC replication group details

Examples

Request
GET https://192.168.0.0:4443/dashboard/zones/localzone/replicationgroups 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/zones/localzone/replicationgroups"},
    },
    "_embedded": {
        "instances": [{
            "_links": {
                "self": { "href": "/dashboard/replicationgroups/{rg-id1}" },
                "rglinks": { "href": "/dashboard/replicationgroups/{rg-id1}/rglinks" },
            },
            "replicationRpoLag": "7200",
            "apiChange" : "1",
            "id": "rg-id1",
            "name": "rg_name1",
            "numZones": 3,

            "replicationIngressTraffic": [ {"t":"12345678" , "Bandwidth":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
            "replicationEgressTraffic": [ {"t":"12345678" , "Bandwidth":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],

            "chunksRepoPendingReplicationTotalSize": 500000,
            "chunksJournalPendingReplicationTotalSize": 500000,
            "chunksPendingXorTotalSize": 500000,
            "replicationRpoTimestamp": 12345678,
        }, {
            "_links": {
                "self": { "href": "/dashboard/replicationgroups/{rg-id1}" },
                "rglinks": { "href": "/dashboard/replicationgroups/{rg-id1}/rglinks" },
            }, 
            "apiChange" : "1",
            "id": "rg-id1",
            "name": "rg_name1",
            "numZones": 3,

            "replicationIngressTraffic": [ {"t":"12345678" , "Bandwidth":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
            "replicationEgressTraffic": [ {"t":"12345678" , "Bandwidth":10000}, {"t":"23435455" , " Bandwidth ":10000}, {"t":"55433455" , " Bandwidth ":10000}],
            "chunksRepoPendingReplicationTotalSize": 500000,
            "chunksJournalPendingReplicationTotalSize": 500000,
            "chunksPendingXorTotalSize": 500000,
            "replicationRpoTimestamp": 12345678,
        }]

    }

}


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                                                |
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
url.self                            |           |        |URL to the replication group resource                               |
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
url.rglinks                         |           |        |URL to get data about replication to and from remote zones in this  |
                                    |           |        |replication group                                                   |
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
id                                  |           |        |ID of the replication group                                         |
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
name                                |           |        |Name of the replication group                                       |
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
numZones                            |           |        |Number of zones in the replication group                            |
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
replicationIngressTraffic           |historical |geo     |Average amount of replication data received per second by           |
                                    |           |        |local zone from all remote zones combined as part of this           |
                                    |           |        |replication group.                                                  | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
replicationEgressTraffic            |historical |geo     |Average amount of replication data sent per second from local       |
                                    |           |        |zone to all remote zones combined as part of this replication group | MB/s
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
chunksRepoPendingReplicationTotalSize           |geo     |Total size of all repo chunks in the local zone pending replication |
                                    |           |        |as part of this replication group.                                  | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
chunksJournalPendingReplicationTotalSize        |geo     |Total size of all journal chunks in the local zone pending          |
                                    |           |        |replication as part of this replication group.                      | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
chunksPendingXorTotalSize           |           |geo     |Total size of all pending XOR operation chunks replicated           |
                                    |           |        |to the local zone as part of this replication group.                | Bytes
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
replicationRpoTimestamp             |           |geo     |Recovery Point Objective for the zone related to this replication   |
                                    |           |        |group - Timestamp of the oldest chunk in this replication group     |
                                    |           |        |that can be lost in case of the local zone failure.                 |
                                    |           |        |Present only when chunksRepoPendingReplicationTotalSize is > 0      | Seconds
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
replicationRpoLag                   |           |geo     |Recovery Point Objective time lag for the zone related to this      |
                                    |           |        |replication group - Time lag of the oldest chunk in this replication|
                                    |           |        |group that can be lost in case of the local zone failure.           |
                                    |           |        |Present only when chunksRepoPendingReplicationTotalSize is > 0.     |
                                    |           |        |More reliable than "replicationRpoTimestamp"                        | Seconds
------------------------------------+-----------+-----------------------------------------------------------------------------+--------
Dell Technologies ECS REST API v3.8.0.2.138627.f5f4887