All Products
Search
Document Center

Dataphin:Upgrade Records

Last Updated:Mar 04, 2026

View upgrade records

An upgrade record is generated whenever an upgrade is performed, except when you cancel an upgrade without saving the configuration.

  1. In Dataphin Manager, in the navigation pane on the left, choose System Configuration > Version Upgrade.

  2. On the Upgrade Records page, you can view the list of upgrade records. The list shows the target version, initial version, upgrade mode, upgrade start time, upgrade duration, maintenance mode start time, maintenance mode duration, status, and actions.

    • Upgrade time: The start time (when maintenance upgrade mode starts) and end time (when you click Finish after the verification is complete).

    • Upgrade duration: The total duration of the upgrade, in hhh:mm:ss format.

    • Maintenance mode time: The time when maintenance upgrade mode starts and the time when it ends.

    • Maintenance mode duration: The total duration of the maintenance upgrade mode, in hhh:mm:ss format.

    • Status: Includes Configuring, Upgrading, Verifying, Upgrade Succeeded, Upgrade Failed, Upgrade Stopped, Force-Stopped and Marked as Succeeded, and Force-Stopped and Marked as Failed.

  3. In the Actions column of an upgrade record, you can perform operations. The available actions vary depending on the record status, as shown in the following table.

    Action

    Description

    Resume upgrade

    Only records with status Configuring or Upgrading support resuming the upgrade.

    Click the image icon in the Actions column of the target record to navigate to the Upgrade Dataphin page. Continue configuring or executing the current upgrade step.

    Resume verification

    Only records with status Verifying support resuming verification.

    Click the image icon in the Actions column of the target record to navigate to the Dataphin Upgrade page. Continue the verification process.

    Cancel upgrade

    Only records with status Configuring support canceling the upgrade.

    Click the image icon in the Actions column of the target record, and click OK in the dialog box that appears.

    Stop upgrade

    Stopping an upgrade is supported only when the status is Upgrading and either the force-stop task has not yet run or application shutdown has not started.

    1. Click the image icon in the Actions column of the target record.

    2. In the Stop Upgrade dialog box, choose whether to Rerun force-stopped instances, then click OK.

    Note
    • After stopping the upgrade, the system resumes job scheduling and exits maintenance upgrade mode.

    • If you choose to rerun force-stopped tasks, the system automatically reruns them after the upgrade stops. If you do not choose this option, the system does not rerun them automatically. You can manually rerun them later in the task O&M module.

    Force-stop upgrade

    Important

    Records with status Upgrading support force-stopping the upgrade. However, force-stopping cannot be self-healed by the system and may render Dataphin unavailable. Before force-stopping, confirm that you have manually completed the upgrade or rollback. Only qualified O&M engineers should confirm and perform this action.

    1. Click the image icon in the Actions column of the target record.

    2. In the dialog box that appears, select the upgrade result. Choose either Upgrade succeeded: Dataphin has been upgraded to the new version or Upgrade failed: Dataphin has been rolled back to the original version.

    3. Select the Declaration checkbox, then click Confirm Force Stop.

    Complete upgrade

    Only records with status Verifying support completing the upgrade.

    Click the image icon in the Actions column of the target record, and in the dialog box that appears, click OK.

    View log

    Only records with status Upgrade Succeeded, Upgrade Stopped, Force-Stopped and Marked as Succeeded, or Force-Stopped and Marked as Failed support viewing logs.

    Click the image icon in the Actions column of the target record to view the upgrade logs of the current upgrade record in the View Log panel. For log details, see View logs.

View log

The upgrade log includes information such as the upgrade status, configuration file, upgrade mode, DataService Studio upgrade mode, upgrade time, maintenance time, and a detailed upgrade timeline.

  • Configuration file: You can download an encrypted configuration file. A one-time temporary password is provided during the download to decrypt the file.

  • Upgrade mode and DataService Studio upgrade mode: The upgrade modes selected during the upgrade.

  • Upgrade: Refers to the entire process from entering maintenance upgrade mode to completing verification.

    • Start time: The time when maintenance upgrade mode starts. If the upgrade was canceled, this field displays -.

    • End time: The time when you click Finish after verification is complete. If the upgrade was canceled, this field displays -. If the upgrade was force-stopped, this field displays the time when the force-stop operation was completed.

    • Total duration: Calculated as End time - Start time. If the upgrade was canceled, this field displays -.

  • Maintenance mode: Refers to the period from entering maintenance upgrade mode to exiting it. During this time, users cannot use the console.

    • Start time: The time when maintenance upgrade mode starts. If the upgrade was canceled, this field displays -.

    • End time: The time when maintenance upgrade mode ends. If the upgrade was canceled or force-stopped, this field displays -.

    • Total duration: Calculated as End time - Start time. If the upgrade was canceled or force-stopped, this field displays -.

    Note

    Zero-downtime upgrade records do not include maintenance mode information.

  • Detailed upgrade timeline: Shows the start and end times of key nodes in sequence. For nodes with a very short duration, only the completion time is shown. If a node has not started or is still running, no time is shown. For nodes with a longer duration, both the start and end times are shown. If a node has started but not finished, it appears as {Start time} ~ .

    • Stop services: Displays the start and end times. The start time is when the first service started stopping. The end time is when the last service finished stopping.

    • Database Backup: Displays the start and end times. The start time is when the backup of the first database began. The end time is when the backup of the last database was completed.

    • Upgrade services: Displays the start and end times. The start time is when the first service of the new version started. The end time is when the last service of the new version finished starting.

    • Data update: Displays the start and end times, along with the execution details for each task. The start time is when the first data update task started. The end time is when the last data update task finished.

      The data update process can include multiple tasks. If it does, the execution status, start and end times, and a link to view details are displayed for each task. The status can be Success, Failed, or Skipped. A status of Skipped indicates that the step was omitted during the upgrade. If there are no data update tasks, this section is not displayed.

    • DataService Studio upgrade time: Displays the start and end times. The start time is when the DataService Studio upgrade began. The end time is when the DataService Studio upgrade was completed.

    Note

    Zero-downtime upgrade records do not include the detailed upgrade timeline.