Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Uploads
- S3 Bucket Location
- 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 Init Uploads
- S3 Object Replication Info Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- EMC Atmos
- OpenStack Swift
ECS API Changes
Get Local Zone Replication Group Bootstrap Links
GET /dashboard/zones/localzone/rglinksBootstrap
Gets the local VDC replication group bootstrap links details.
Required Roles
Requires one of the following roles:
SYSTEM_MONITOR
SYSTEM_ADMIN
Response Body
Local VDC replication group bootstrap links details.
JSON Example
Request
GET https://192.168.0.0:4443/dashboard/zones/localzone/rglinksBootstrap 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/rglinksBootstrap"},
},
"_embedded": {
"instances": [{
"_links": {
"self": { "href": "dashboard/zones/localzone/rglinksBootstrap" }
},
"apiChange" : "1",
"id": "rglink-id1",
rgName: "rg-name",
zone1Name: VDC1,
zone2Name: VDC2,
rglinkStatus: "Good",
"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,
"replicationRepoChunksRpoTimestamp": 12345678,
"replicationJournalChunksRpoTimestamp": 12345678,
"replicationRpoTimestamp": 12345678
"chunksRepoPendingBootstrapReplicationTotalSize": 500000,
"chunksJournalPendingBootstrapReplicationTotalSize": 500000,
"chunksBTreePendingBootstrapReplicationTotalSize": 500000
"BootstrapState": "ReplicateBTree",
"BootstrapProgressPercent": 20
}, {
"_links": {
"self": { "href": "/dashboard/rglinks/{rglink-id2}" }
},
"apiChange" : "1",
"id": "rglink-id2",
rgName: "rg-name",
zone1Name: VDC1,
zone2Name: VDC3,
rglinkStatus: "Bad",
"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,
"replicationRepoChunksRpoTimestamp": 12345678,
"replicationJournalChunksRpoTimestamp": 12345678,
"replicationRpoTimestamp": 12345678
"chunksJournalPendingBootstrapReplicationTotalSize": 500000,
"chunksBTreePendingBootstrapReplicationTotalSize": 500000
"BootstrapState": "ReplicateBTree",
"BootstrapProgressPercent": 20
}]
}
}
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 a resource for replication to and from a remote zones |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
id | | |ID of the pair of local and the remote zone in this replication group |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
rgName | | |Replication group name |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
zone1Name | | |Local zone name |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
zone2Name | | |Remote zone name |
------------------------------------+-----------+-------------------------------------------------------------------------------+-------
rglinkStatus | |geo |Status of the replication to the remote zone in the replication group |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
replicationIngressTraffic |historical |geo |Average amount of replication data received per second by local zone |
| | |from the remote zone as part of this replication group. | MB/s
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
replicationEgressTraffic |historical |geo |Average amount of replication data sent per second from local zone |
| | |to the remote zone as part of this replication group. | MB/s
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksRepoPendingReplicationTotalSize |geo |Total size of all repo chunks in the local zone pending replication |
| | |to the remote zone as part of this replication group. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksJournalPendingReplicationTotalSize |geo |Total size of all journal chunks in the local zone pending replication|
| | |to the remote zone as part of this replication group. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksPendingXorTotalSize | |geo |Total size of all pending XOR operation chunks replicated to the local|
| | |zone from the remote zone as part of this replication group. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
replicationRpoTimestamp | |geo |Recovery Point Objective for the local zone related to the remote |
| | |zone as part of this replication group - Timestamp of the oldest chunk|
| | |in this replication group not yet replicated to the remote zone that |
| | |can be lost in case of the local zone failure. Present only when | Seconds
| | |chunksRepoPendingReplication is > 0 |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksRepoPendingFailoverRereplicationTotalSize |geo |Total size of all repo chunks in the local zone pending |
| | |re-replication as part of this replication group due to failure |
| | |of the remote zone. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksJournalPendingFailoverRereplicationTotalSize geo |Total size of all journal chunks in the local zone pending |
| | |re-replication as part of this replication group due to failure of |
| | |the remote zone. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksBTreePendingFailoverRereplicationTotalSize|geo |Total size of all BTree chunks in the local zone pending |
| | |re-replication as part of this replication group due to failure |
| | |of the remote zone. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksRepoPendingFailoverXorDecodingTotalSize |geo |Total size of all Repo chunks in the local zone pending XOR decoding |
| | |as part of this replication group due to failure of the remote zone | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
FailoverState | |geo |State of the recovery from the failure of the remote zone as part of |
| | |this replication group, present when one of the sites is brought down |
| | |Possible values: |
| | |"0 = STARTED" |
| | |"1 = BLIND_REPLAY_DONE" |
| | |"2 = REPLICATION_CHECK_DONE" |
| | |"3 = CONSISTENCY_CHECK_DONE" |
| | |"4 = FAILURE_MODE_REPLAY_DONE" |
| | |"5 = ZONE_SYNC_DONE" |
| | |"6 = ZONE_BOOTSTRAP_DONE" |
| | |"7 = RECOVERY_DONE" |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
FailoverProgressPercent | |geo |Estimated percentage of failover progress in the local zone |
| | |recovering from failure of the remote zone as part of this |
| | |replication group, present when one of the sites is brought down | Percent
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksRepoPendingBootstrapReplicationTotalSize |geo |Total size of all repo chunks in the local zone pending bootstrap |
| | |replication as part of this replication group due to addition of the |
| | |remote zone to the replication group. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksJournalPendingBootstrapReplicationTotalSize geo |Total size of all journal chunks in the local zone pending |
| | |bootstrap replication as part of this replication group due to |
| | |addition of the remote zone to the replication group. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
chunksBTreePendingBootstrapReplicationTotalSize |geo |Total size of all BTree chunks in the local zone pending bootstrap |
| | |replication as part of this replication group due to addition of the |
| | |remote zone to the replication group. | Bytes
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
BootstrapState | |geo |State of the bootstrap processing in the local zone for addition of |
| | |the remote zone as part of this replication group. |
| | |Possible values: |
| | |"0 - BTreeScan", |
| | |"1 - ReplicateBTree", |
| | |"2 - ReplicateBTreeMarker", |
| | |"3 - ReplicateJournal", |
| | |"4 - Done" |
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------
BootstrapProgressPercent | |geo |Estimated percentage of bootstrap progress in the local zone for |
| | |addition of the remote zone as part of this replication group. | Percent
------------------------------------+-----------+--------+----------------------------------------------------------------------+-------