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+

Name	Description	Type	Notes
restore_component		string	Readonly Enum: LOCAL_MANAGER, GLOBAL_MANAGER Default: "LOCAL_MANAGER"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/restore/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ClusterRestoreStatus+

Name	Description	Type	Notes
backup_timestamp	Timestamp when backup was initiated in epoch millisecond	EpochMsTimestamp	Required Readonly
endpoints	The list of allowed endpoints, based on the current state of the restore process	array of ResourceLink	Required Readonly
id	Unique id for backup request	string	Required Readonly
instructions	Instructions for users to reconcile Restore operations	array of InstructionInfo	Readonly
restore_end_time	Timestamp when restore was completed in epoch millisecond	EpochMsTimestamp	Readonly
restore_start_time	Timestamp when restore was started in epoch millisecond	EpochMsTimestamp	Readonly
status		GlobalRestoreStatus
step		RestoreStep
total_steps	Total number of steps in the entire restore process	integer	Required Readonly

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": [ "Log into these fabric nodes with root access and run reset_nsx_after_mp_restore.sh", "Restart node agent" ], "fields": ["display_name", "id", "resource_type", "IP"] }, { ... } ] }

Query Restore Request Status

Request:

ClusterRestoreStatusRequestParameters (schema)

Example Request:

Successful Response:

ClusterRestoreStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: