Skip to main content
GET

Overview

Get the result status of data migration process, used to monitor the progress and status of data migration.

Response Fields

status
string
required
Migration status:
  • running - Migration is in progress
  • completed - Migration has completed
  • migrated - Migration has completed (historical status)
  • failed - Migration has failed
step
string
required
Current migration step, e.g., message, user, channel, etc.
last_err
string
Last error message, null if no error occurred
try_count
integer
required
Number of attempts made

Status Codes

Use Cases

Migration Monitoring

Real-time Migration Monitoring:

Migration Dashboard

Migration Dashboard Implementation:

Automated Migration Management

Automated Migration Workflow:

Best Practices

  1. Regular Monitoring: Check migration status every 5-10 seconds during active migration
  2. Error Handling: Handle network errors and server errors gracefully
  3. Status Caching: Avoid redundant processing when status hasn’t changed
  4. Notification System: Notify relevant personnel when migration completes or fails
  5. Logging: Record key status changes during the migration process
  6. Timeout Management: Set appropriate timeouts for migration operations
  7. Retry Logic: Implement retry mechanisms for failed migration attempts
  8. Progress Tracking: Provide clear progress indicators for long-running migrations