Get migration status summary

Request:

Method:

GET

URI Path(s):

/api/v1/migration/status-summary

Request Headers:

n/a

Query Parameters:

MigrationStatusSummaryRequestParameters+

Name	Description	Type	Notes
component_type	Component type based on which migration units to be filtered	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/migration/status-summary

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MigrationStatus+

Name	Description	Type	Notes
component_status	List of component statuses	array of ComponentMigrationStatus	Required Readonly
overall_migration_status	Status of migration	string	Required Readonly Enum: SUCCESS, FAILED, IN_PROGRESS, NOT_STARTED, PAUSED

Example Response:

{ "component_status": [ { "component_type": "PRECHECK", "status": "IN_PROGRESS", "percent_complete": 40, "details": "Collecting config", "can_skip": false }, { "component_type": "CONFIG_MIGRATION", "status": "NOT_STARTED", "percent_complete": 0, "can_skip": false } { "component_type": "HOST", "status": "NOT_STARTED", "percent_complete": 0, "can_skip": false } }

Required Permissions:

read

Feature:

utilities_upgrade

Additional Errors:

301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable