Query Cluster Restore Status
Returns status information for the specified NSX cluster restore request.
Request
URI
GET
https://nsxmanager.your.domain/api/v1/cluster/restore/status
COPY
Responses
200
OK
Returns ClusterRestoreStatus of type(s) application/json
{
"status": {
"description": "string",
"value": "string"
},
"step": {
"status": {
"description": "string",
"value": "string"
},
"step_number": 0,
"description": "string",
"value": "string"
},
"endpoints": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"total_steps": 0,
"restore_start_time": 0,
"restore_end_time": 0,
"backup_timestamp": 0,
"id": "string",
"instructions": [
{
"fields": [
"string"
],
"id": "string",
"actions": [
"string"
],
"name": "string"
}
]
}array of ResourceLink
endpoints
Optional
The list of allowed endpoints, based on the current state of the restore process
integer As int64 As int64
total_steps
Optional
Total number of steps in the entire restore process
integer As int64 As int64
restore_start_time
Optional
Timestamp when restore was started in epoch millisecond
integer As int64 As int64
restore_end_time
Optional
Timestamp when restore was completed in epoch millisecond
integer As int64 As int64
backup_timestamp
Optional
Timestamp when backup was initiated in epoch millisecond
string
id
Optional
Unique id for backup request
array of InstructionInfo
instructions
Optional
Instructions for users to reconcile Restore operations
400
Returns BadRequest of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
403
Forbidden
Returns ClusterRestoreStatus of type(s) application/json
{
"status": {
"description": "string",
"value": "string"
},
"step": {
"status": {
"description": "string",
"value": "string"
},
"step_number": 0,
"description": "string",
"value": "string"
},
"endpoints": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"total_steps": 0,
"restore_start_time": 0,
"restore_end_time": 0,
"backup_timestamp": 0,
"id": "string",
"instructions": [
{
"fields": [
"string"
],
"id": "string",
"actions": [
"string"
],
"name": "string"
}
]
}array of ResourceLink
endpoints
Optional
The list of allowed endpoints, based on the current state of the restore process
integer As int64 As int64
total_steps
Optional
Total number of steps in the entire restore process
integer As int64 As int64
restore_start_time
Optional
Timestamp when restore was started in epoch millisecond
integer As int64 As int64
restore_end_time
Optional
Timestamp when restore was completed in epoch millisecond
integer As int64 As int64
backup_timestamp
Optional
Timestamp when backup was initiated in epoch millisecond
string
id
Optional
Unique id for backup request
array of InstructionInfo
instructions
Optional
Instructions for users to reconcile Restore operations
404
Returns NotFound of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
412
Returns PreconditionFailed of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
500
Returns InternalServerError of type(s) application/json
{
"details": "string",
"related_errors": [
"ApiError Object"
],
"module_name": "string",
"error_message": "string",
"error_code": 0
}object
error_data
Optional
Additional data about the error
string
details
Optional
Further details about the error
string
module_name
Optional
The module name where the error occurred
string
error_message
Optional
A description of the error
integer As int64 As int64
error_code
Optional
A numeric error code
503
Service Unavailable
Returns ClusterRestoreStatus of type(s) application/json
{
"status": {
"description": "string",
"value": "string"
},
"step": {
"status": {
"description": "string",
"value": "string"
},
"step_number": 0,
"description": "string",
"value": "string"
},
"endpoints": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"total_steps": 0,
"restore_start_time": 0,
"restore_end_time": 0,
"backup_timestamp": 0,
"id": "string",
"instructions": [
{
"fields": [
"string"
],
"id": "string",
"actions": [
"string"
],
"name": "string"
}
]
}array of ResourceLink
endpoints
Optional
The list of allowed endpoints, based on the current state of the restore process
integer As int64 As int64
total_steps
Optional
Total number of steps in the entire restore process
integer As int64 As int64
restore_start_time
Optional
Timestamp when restore was started in epoch millisecond
integer As int64 As int64
restore_end_time
Optional
Timestamp when restore was completed in epoch millisecond
integer As int64 As int64
backup_timestamp
Optional
Timestamp when backup was initiated in epoch millisecond
string
id
Optional
Unique id for backup request
array of InstructionInfo
instructions
Optional
Instructions for users to reconcile Restore operations
Nsx Component Administration Operations
POST
Add Certificate Import
POST
Add Cluster Node
POST
Add Crl Import
POST
Add Node User Ssh Key Add Ssh Key
POST
Advance Cluster Restore Advance
POST
Cancel Appliance Management Task Cancel
POST
Cancel Cluster Restore Cancel
GET
Check Rabbit MQ Management Port
POST
Clear Cluster Certificate Clear Cluster Certificate
GET
Collect Alarms
POST
Collect Audit Logs
POST
Collect Support Bundles Collect
PUT
Configure Backup Config
PUT
Configure Restore Config
POST
Copy From Remote File Copy From Remote File
POST
Copy To Remote File Copy To Remote File
POST
Create Appliance Management Service Action Restart
POST
Create Cluster Boot Manager Service Action Restart
POST
Create Cluster Boot Manager Service Action Start
POST
Create Cluster Boot Manager Service Action Stop
POST
Create Cminventory Service Action Restart
POST
Create Cminventory Service Action Start
POST
Create Cminventory Service Action Stop
POST
Create Datastore Service Action Restart
POST
Create Datastore Service Action Start
POST
Create Datastore Service Action Stop
POST
Create File
POST
Create Liagent Service Action Restart
POST
Create Liagent Service Action Start
POST
Create Liagent Service Action Stop
POST
Create Node Network Route
POST
Create NSX Message Bus Service Action Restart
POST
Create NSX Message Bus Service Action Start
POST
Create NSX Message Bus Service Action Stop
POST
Create Nsx Ui Service Service Action Restart
POST
Create Nsx Ui Service Service Action Start
POST
Create Nsx Ui Service Service Action Stop
POST
Create Nsx Upgrade Agent Service Action Restart
POST
Create Nsx Upgrade Agent Service Action Start
POST
Create Nsx Upgrade Agent Service Action Stop
POST
Create NTP Service Action Restart
POST
Create NTP Service Action Start
POST
Create NTP Service Action Stop
POST
Create Phonehome Coordinator Service Action Restart
POST
Create Phonehome Coordinator Service Action Start
POST
Create Phonehome Coordinator Service Action Stop
POST
Create Proton Service Action Restart
POST
Create Proton Service Action Start
POST
Create Proton Service Action Stop
POST
Create Proxy Service Action Restart
POST
Create Proxy Service Action Start
POST
Create Proxy Service Action Stop
POST
Create Proxy Service Apply Certificate Action Apply Certificate
POST
Create Rabbit MQ Service Action Restart
POST
Create Rabbit MQ Service Action Start
POST
Create Rabbit MQ Service Action Stop
POST
Create Remote Directory Create Remote Directory
POST
Create Repository Service Action Restart
POST
Create Repository Service Action Start
POST
Create Repository Service Action Stop
POST
Create Search Service Action Restart
POST
Create Search Service Action Start
POST
Create Search Service Action Stop
POST
Create SNMP Service Action Restart
POST
Create SNMP Service Action Start
POST
Create SNMP Service Action Stop
POST
Create SSH Service Action Restart
POST
Create SSH Service Action Start
POST
Create SSH Service Action Stop
POST
Create SSH Service Remove Host Fingerprint Action Remove Host Fingerprint
POST
Create Syslog Service Action Restart
POST
Create Syslog Service Action Start
POST
Create Syslog Service Action Stop
DELETE
Delete Appliance Management Task
DELETE
Delete Certificate
DELETE
Delete Cluster Node Config
DELETE
Delete Crl
DELETE
Delete Csr
DELETE
Delete File
DELETE
Delete Node Network Route
DELETE
Delete Node Syslog Exporter
POST
Delete Node User Ssh Key Remove Ssh Key
DELETE
Delete Principal Identity
DELETE
DELETE Rabbit MQ Management Port
POST
Generate Csr
GET
Get Backup Config
GET
Get Backup History
GET
Get Backup Status
GET
Get Certificate
GET
Get Certificates
GET
Get Cluster Certificate Id
GET
Get Crl
GET
Get Crls
GET
Get Csr
GET
Get Csr Pem
GET
Get Csrs
GET
Get Node Mandatory Access Control
GET
Get Node Mandatory Access Control Report
GET
Get Node Mode
GET
Get Principal Identities
GET
Get Principal Identity
GET
Get Restore Config
POST
Get Ssh Fingerprint Of Server Retrieve Ssh Fingerprint
GET
Get Trust Objects
POST
Import Certificate Import
POST
Initiate Cluster Restore Start
DELETE
Invoke Delete Cluster Central API
DELETE
Invoke Delete Fabric Central API
GET
Invoke Get Cluster Central API
GET
Invoke Get Fabric Central API
POST
Invoke Post Cluster Central API
POST
Invoke Post Fabric Central API
PUT
Invoke Put Cluster Central API
PUT
Invoke Put Fabric Central API
GET
List Appliance Management Tasks
GET
List Cluster Backup Timestamps
GET
List Cluster Node Configs
GET
List Cluster Node Interfaces
GET
List Files
GET
List Node Interfaces
GET
List Node Network Routes
GET
List Node Processes
GET
List Node Services
GET
List Node Syslog Exporters
GET
List Node Users
GET
List Node User Ssh Keys
GET
List Restore Instruction Resources
POST
Post Node Syslog Exporter
GET
Query Cluster Restore Status
GET
Read Appliance Management Service
GET
Read Appliance Management Service Status
GET
Read Appliance Management Task Properties
GET
Read Appliance Node Status
GET
Read Asnyc Appliance Management Task Response
GET
Read Auth Provider Vidm
GET
Read Auth Provider Vidm Status
GET
Read Cluster Boot Manager Service
GET
Read Cluster Boot Manager Service Status
GET
Read Cluster Config
GET
Read Cluster Node Config
GET
Read Cluster Node Interface
GET
Read Cluster Node Interface Statistics
GET
Read Cluster Nodes Aggregate Status
GET
Read Cluster Node Status
GET
Read Cluster Status
GET
Read Cminventory Service
GET
Read Cminventory Service Status
GET
Read Datastore Service
GET
Read Datastore Service Status
GET
Read File
GET
Read File Properties
GET
Read File Thumbprint
GET
Read Liagent Service
GET
Read Liagent Service Status
GET
Read Management Config
GET
Read Network Interface Statistics
GET
Read Network Properties
GET
Read Node Interface
GET
Read Node Name Servers
GET
Read Node Network Route
GET
Read Node Process
GET
Read Node Properties
GET
Read Node Search Domains
GET
Read Node Support Bundle
GET
Read Node Syslog Exporter
GET
Read Node User
GET
Read Node Version
GET
Read NSX Message Bus Service
GET
Read NSX Message Bus Service Status
GET
Read Nsx Ui Service Service
GET
Read Nsx Ui Service Service Status
GET
Read Nsx Upgrade Agent Service
GET
Read Nsx Upgrade Agent Service Status
GET
Read NTP Service
GET
Read NTP Service Status
GET
Read Phonehome Coordinator Service
GET
Read Phonehome Coordinator Service Status
GET
Read Proton Service
GET
Read Proton Service Status
GET
Read Proxy Service
GET
Read Proxy Service Status
GET
Read Rabbit MQ Service
GET
Read Rabbit MQ Service Status
GET
Read Repository Service
GET
Read Repository Service Status
GET
Read Search Service
GET
Read Search Service Status
GET
Read SNMP Service
GET
Read SNMP Service Status
GET
Read SSH Service
GET
Read SSH Service Status
GET
Read Syslog Service
GET
Read Syslog Service Status
POST
Register Principal Identity
POST
Request Onetime Backup Backup To Remote
POST
Request Onetime Inventory Summary Summarize Inventory To Remote
POST
Reset Proton Service Logging Level Action Reset Manager Logging Levels
POST
Restart Or Shutdown Node Restart
POST
Restart Or Shutdown Node Shutdown
POST
Retry Cluster Restore Retry
POST
Revoke Missing Cluster Node Config Revoke Missing Nodes
POST
Self Sign Certificate Self Sign
POST
Set Cluster Certificate Set Cluster Certificate
PUT
Set Node Mandatory Access Control
POST
Set Rabbit MQ Management Port
POST
Suspend Cluster Restore Suspend
PUT
Update Auth Provider Vidm
PUT
Update Cluster Config
PUT
Update Crl
PUT
Update File
PUT
Update Management Config
PUT
Update Node Interface
PUT
Update Node Name Servers
PUT
Update Node Properties
PUT
Update Node Search Domains
PUT
Update Node User
PUT
Update NTP Service
POST
Update Principal Identity Certificate Update Certificate
PUT
Update Proton Service
PUT
Update Proxy Service
PUT
Update Repository Service
PUT
Update SNMP Service
PUT
Update SSH Service