Undeploy and restore scheduled nodes in DataWorks - DataWorks

Undeploying a node removes it from the development environment and deploys the deletion to the production scheduling system. After a node is undeployed, it can no longer be scheduled. This topic describes how to undeploy and restore a scheduled task in a standard workspace and explains how DataWorks handles existing and running instances after the node is undeployed.

Usage notes

To ensure that downstream tasks run as expected, DataWorks allows you to undeploy only nodes that have no downstream dependencies. Attempting to undeploy a node with dependencies results in an error. For more information, see Error: The node has child nodes, causing the task deletion or undeployment to fail. To view the dependencies of a node, see Manage scheduled tasks.
A node that is undeployed from the Periodic tasks page in the production environment's Operation Center reverts to an editable state in the development environment by default and is not moved to the recycle bin. You can find the node by searching for its name in DataStudio.

Undeploy a node

The following figure shows the procedure for undeploying a scheduled task. 任务下线流程

Step 1: Delete the node in development

Delete the node in DataStudio.

Actions	Description
Delete a single node	You can delete a specific node from the workflow directory or the workflow panel. After deletion, commit the current workflow by clicking the icon. In DataStudio, you can delete a single node in two ways. Method 1: In the workflow directory on the left, right-click the target node and select Delete. Method 2: On the workflow DAG panel on the right, right-click the target node and select Delete Node.
Delete nodes in batches	You can use the batch operation feature to delete multiple nodes at once. Click the Batch Operation icon in the toolbar to go to the Batch Operation - DataStudio page. On the Node tab, select the nodes that you want to delete from the list, then click More in the bottom action bar and select Delete.
Delete nodes by using a node group	You can create a node group by selecting multiple nodes and then delete specific nodes from it. You can also delete nodes from an existing node group. After deletion, commit the current workflow by clicking the icon. On the canvas toolbar, click the selection tool to select the target node group, right-click it, and select Delete Node Group from the context menu.

Step 2: Deploy the deletion to production

After you delete a node in DataStudio, DataWorks by default creates a pending undeployment record on the Deployment > Create Deploy Task page. A user with Workspace Administrator or O&M permissions must deploy this record to the production environment. On this page, select the target undeployment record and click Deploy Selected Items. The node in the production environment is undeployed only after the deployment is successful. The deployment process may be subject to certain workflow controls, so ensure that the operation completes successfully. For more information about the deployment process and permission controls, see Deployment.

Step 3: Confirm the undeployment

Go to the Operation Center > Periodic tasks page. If the node no longer appears in the list, the node has been successfully undeployed.

Impact of undeployment on existing instances

Instances that have not run

During the undeployment process, instances that have not started running are skipped. Their status is immediately set to Succeeded, but the task itself does not run. In pay-as-you-go billing, you are not charged a scheduling fee for these skipped instances.
Running instances

Instances that are already running when the undeployment occurs will continue to execute normally.

Note

You cannot manually delete instances. They are automatically deleted after a retention period of approximately 30 days.
If a scheduled task does not need to run on a specific day, you can freeze the instances scheduled for that day. If a task does not need to run for an extended period, you can freeze the scheduled task itself. For more information, see Basic O&M operations for scheduled tasks.

Restore a node

You can restore the 100 most recently deleted nodes from the recycle bin in DataStudio and then commit and deploy them again.

Note

Restoring a node generates a new node ID.
You can restore only items (including nodes, resources, and functions) that have been deleted from both the development environment and the production environment. Otherwise, the following error occurs: Error: Please first deploy the file ${filename} to the production environment or cancel the deployment in the Deployment center.

FAQ

Error: Please first deploy the file ${filename} to the production environment or cancel the deployment in the Deployment center

Cause: The Recycle Bin in DataWorks can restore items, such as nodes, resources, or functions, only if they have been deleted from both the development and production environments. This error occurs if an item is deleted from the development environment but this deletion has not been deployed to the production environment.
Solution: Go to the task deployment page, cancel the deployment for the current task, and then restore the file in Data Studio.

Error: The node has child nodes, causing the task deletion or undeployment to fail

Cause: To ensure the normal execution of downstream tasks, DataWorks allows you to undeploy a task only when the task has no downstream dependencies in both the development and production environments.

Note
Undeploying a node may cause other tasks that depend on this node to run abnormally. Communicate with the owners of all tasks that depend on this node before you proceed.
Solution:
1. Check the downstream dependencies of the task to be undeployed: Go to the scheduled task page in Operation Center for both the development and production environments, and check whether the task has downstream dependencies. For more information, see View node dependencies.
2. Remove the downstream dependencies of the task to be undeployed:
  1. Go to the schedule settings page of the downstream dependent task and remove the dependency on the task to be undeployed. For more information, see Delete or change node dependencies.
  2. Submit the downstream task to remove the dependency between the downstream task and the task to be undeployed in the development environment.
  3. Deploy the downstream task to remove the dependency between the downstream task and the task to be undeployed in the production environment.
  4. Continue to undeploy the task. For more information, see Undeploy a task.