NSX-T Data Center REST API

Query Restore Request Status

Returns status information for the specified NSX cluster restore request.

Request:

Method:
GET
URI Path(s):
/api/v1/cluster/restore/status
Request Headers:
n/a
Query Parameters:
ClusterRestoreStatusRequestParameters+
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

Example Response:

{ "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1415830945573, "restore_start_time": 1415830945573, "restore_end_time": 1415830947433, "step": { "step_number": 7, "value": "MANAGER_RESTARTING", "description": "Restarting manager", "status": { "value": "RUNNING", "description": "The manager is restarting" } }, "status": { "value": "RUNNING", "description": "The operation is currently running" }, "total_steps": 11, #TODO: Fill in endpoints when state machine is finalized. "endpoints": [], "instructions": [ { "id": "48F45150-038C-4664-B468-36FFE1B356F9", "name": "Reset Fabric Nodes", "actions": [ "Login to these nodes and from the nsxcli run the 'del nsx' command", "Restart node agent" ], "fields": ["display_name", "id", "resource_type", "IP"] }, { ... } ] }

Required Permissions:

read

Feature:

utilities_backup

Additional Errors: