System Administration >
Configuration
>
Site Management
Get overall status of the federation, including stub status
Request:
Method:
GET
URI Path(s):
/api/v1/sites/status
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/sites/status
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
FederationStatus
+
FederationStatus
(
schema
)
Name
Description
Type
Notes
active_standby_sync_statuses
Status of synchronization between active and standby sites.
array of
ActiveStandbySyncStatus
Required
remote_connections
Site connection status
array of
SiteStatus
Example Response:
{ "remote_connections": [ { "site_name": "site name", "stubs": { "address": "10.160.223.31", "connection_up": true } } ], "active_standby_sync_statuses": [ { "standby_site": "London", "is_data_consistent": true, "description": "status description", "status": "ONGOING", "percentage_completed": 70, "remaining_entries_to_send": 5, "sync_type": "DELTA_SYNC", "full_sync_status": { "sync_id": "9d33ec11-3c7a-46bc-80f9-88adc21c8289", "status": "COMPLETE", "sync_type": "STANDARD", "completed_at": "1600913640000", "snapshot_version": "781" } } ] }
Required Permissions:
read
Feature:
cluster_management
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable