DataWorks allows you to view information and perform operations on pages such as Overview, Workspaces, and Resource Groups in the DataWorks console.

Background information

If you log on to the DataWorks console as a RAM user, you may not be able to view specific features in the DataWorks console, or an error may be reported when you use a feature in the DataWorks console. In this case, you must check whether the RAM user that you used to log on is granted the required permissions. For more information, see Permission control by fine-grained RAM policies.

You can view different information and perform different operations on the following pages in the DataWorks console.

Page name Description
Overview On the Overview page, you can view the workspaces that are recently used by the current logon account and configure the workspaces. You can also view product updates and news on the Overview page.
Workspaces On the Workspaces page, you can view all workspaces in the current logon account and perform different operations on the workspaces. You can also create a workspace on the Workspace page and refresh the workspace list.
Resource Groups On the Resource Groups page, you can view and manage all exclusive resource groups and shared resource groups in the current logon account.
Alerts On the Alert Resource page, you can view the alert resources in the current logon account in a specified region. You can also specify the maximum number of alert notifications that can be sent by text message or phone call per day.
Open Platform On the Open Platform page, you can use the OpenAPI module, OpenEvent module, and Extensions module to integrate your applications with DataWorks.
Compute Engines On the MaxCompute page, Graph Compute page, or Hologres page, you can view the list of compute engine instances that are created in the current logon account.
Lake and Warehouse Integration (Data Lakehouse) On the Lake and Warehouse Integration (Data Lakehouse) page, you can build a data management platform that integrates data lakes and data warehouses.

Overview

Log on to the DataWorks console. On the Overview page, you can view the workspaces that are frequently used, the regions in which DataWorks is activated, and other shortcuts.

Workspaces

In the left-side navigation pane, click Workspaces. On the Workspaces page, you can view and manage all workspaces that are created in the current logon account. The page displays only the workspaces to which your account is added as a member.
Note If you use a RAM user to log on to the DataWorks console, you can view only the workspaces to which the RAM user is added as a member. If you want to add the RAM user to a workspace, you can contact the workspace administrator to perform the operation. For more information, see Add workspace members and assign roles to them.
DataWorks console
Operation Description References
Select a region In the area marked with 1 in the preceding figure, you can select the desired region and view the Workspaces page for this region. -
Create a workspace In the area marked with 2 in the preceding figure, you can click the button to create a workspace. Create a workspace.
View basic information about a workspace In the area marked with 3 in the preceding figure, you can view basic information about a workspace, such as the workspace mode and workspace administrator.
  • Mode: The Mode parameter displays the mode of a workspace. DataWorks supports workspaces in basic mode and workspaces in standard mode. We recommend that you use a workspace that is in standard mode for data development.
  • Administrator: The Administrator parameter displays the administrator of a workspace. The workspace administrator can add RAM users to the workspace on the User Management page.
Perform operations related to a workspace In the area marked with 4 in the preceding figure, you can click one of the items that are displayed to access the related service or perform operations related to a workspace.
  • Shortcuts: You can click a shortcut in the Actions column of a workspace to quickly access the related service.
  • Workspace Settings: You can modify the basic information and basic security settings of a workspace.
  • Engine Configuration: You can modify or maintain the engine information of a workspace.
  • Delete workspace: You can delete a workspace. After a workspace is deleted, the workspace cannot be recovered.
  • Disable workspace: You can disable a workspace that you no longer require. After a workspace is disabled, the nodes in the workspace are no longer automatically scheduled, but the resources of the compute engine instances exist. You may be charged fees for the resources.
Upgrade the edition of DataWorks
In the area marked with 5 in the preceding figure, the edition upgrade feature is provided.
  • You can click Upgrade to upgrade the edition of DataWorks. DataWorks advanced editions provide a wider range of service capabilities. The service capabilities that are provided by different editions vary.
  • You can activate an advanced edition of DataWorks in a region. Then, you can use the service capabilities that are provided by the edition in all existing workspaces in the region.

For more information about the differences between DataWorks editions, see Differences among DataWorks editions.

Purchase exclusive resources In the area marked with 5 in the preceding figure, you can click Purchase Exclusive Resource to purchase exclusive resources. After the exclusive resources are purchased, you cannot directly see an exclusive resource group. You must click Create Resource Group for Scheduling or Create Resource Group for Data Integration on the Resource Groups page to create an exclusive resource group for scheduling or an exclusive resource group for Data Integration based on the purchased exclusive resources.
Note
  • You can directly create an exclusive resource group for DataService Studio based on the order ID.
  • For more information about the scenarios in which different types of exclusive resource groups are used, see Overview.
  • For more information about the billing of an exclusive resource group for Data Integration, see Overview.
  • For more information about the billing of an exclusive resource group for scheduling, see Overview.

Resource Groups

In the left-side navigation pane, click Resource Groups. In the top navigation bar, select the region in which the resource groups reside. On the Resource Groups page, you can create and manage resource groups.

Operation Description References
Create an exclusive resource group You can create the following types of exclusive resource groups:
  • Exclusive resource group for scheduling: You can create an exclusive resource group for scheduling to schedule batch synchronization nodes and ease scheduling resources constraints.
  • Exclusive resource group for Data Integration: You can create an exclusive resource group for Data Integration to run a data synchronization node. This type of resource group can be used to synchronize data in complex network environments.
View basic information about an exclusive resource group You can view basic information about an exclusive resource group, such as the status, expiration time, and resource usage of the resource group.
  • Status of an exclusive resource group
    • Running: The resource group is in a normal state and can be used to run nodes.
    • Updating: The resource group is being modified. The modifications include scale-out operations, scale-in operations, and specifications change. The modification process may require an extended period of time.
    • Expired: The resource group is expired. A resource group is suspended if the resource group is not renewed upon expiration.
  • Resource usage of a resource group: The real-time usage of the resources in the resource group. If the resource usage of an exclusive resource group is excessively high, you can troubleshoot the issue by referring to View the resource usage of an exclusive resource group.
Perform basic operations on an exclusive resource group You can view the detailed information about an exclusive resource group and perform operations on an exclusive resource group.
  • Perform operations on an exclusive resource group: You can perform operations such as scale-out operations, scale-in operations, specifications change, and renewal on an exclusive resource group.
  • Configure network settings for an exclusive resource group: If you want to connect an exclusive resource group to a data source that is deployed in a specific network environment, you must configure network settings for the resource group. Before you configure network settings, you can select a network connection solution and then refer to the related topic to perform the configuration.
  • Perform O&M on an exclusive resource group for scheduling: You can use O&M Assistant to create, run, and delete commands on an exclusive resource group for scheduling. For more information, see Use the O&M Assistant feature.
  • Change the workspace for an exclusive resource group: The workspace administrator can associate an exclusive resource group with a specific workspace.
Note
  • If you want to reference a third-party package in a PyODPS node, you need to upload the resources to an exclusive resource group for scheduling on the O&M Assistant page.
  • A change operation that is performed on an exclusive resource group may require an extended period of time.

Alerts

In the left-side navigation pane, click Alerts and specify the maximum number of alert notifications that can be sent by text message or phone call per day on the Alert Resource page. Then, view and specify information about an alert contact on the Alert Contacts page.

Item Description References
Alert Resource On the Alert Resource page, you can view the usage of alert resources in the Alert Resource Usage Today and Alert Resource Usage in This Month sections. You can specify the maximum number of alert notifications that can be sent by using each notification method per day.
Important
  • The upper limits that you specify for each notification method take effect only in the current region.
  • If the upper limits are reached, alert notifications can no longer be sent on the same day.
-
-
Alert Contacts On the Alert Contacts page, you can specify a RAM user or a RAM role as an alert contact and customize the contact information. You can also synchronize the contact information that is configured for RAM users with one click.
Note The configured mobile phone number or email address takes effect only after it is activated.
Configure and view alert contacts

Open Platform

In the left-side navigation pane, click Open Platform. DataWorks Open Platform provides the OpenAPI module, OpenEvent module, and Extensions module. You can use the modules to integrate your applications with DataWorks and subscribe to event messages. These modules facilitate process management for data processing, data governance, and data O&M, and allow you to identify important changes in DataWorks and respond to the changes at the earliest opportunity.

Module Description References
OpenAPI The OpenAPI module displays the number of API calls that are made and information about the API operations that are called. You can call DataWorks API operations to use different features of DataWorks and integrate your applications with DataWorks. OpenAPI
OpenEvent The OpenEvent module is an open capability provided by DataWorks. The OpenEvent module allows you to subscribe to event messages. This way, you can receive notifications about various change events in DataWorks and respond to the events based on your configurations at the earliest opportunity. OpenEvent
Extensions DataWorks allows you to use the Extensions module to register programs as DataWorks extensions. You can use the Extensions module together with the message subscription feature provided by the OpenEvent module to manage extension point events and processes. You can also customize configurations based on your business requirements. Extensions

Compute Engines

In the left-side navigation pane, click Compute Engines. Then, click MaxCompute, Graph Compute, or Hologres to view the list of compute engines that you activated on different pages and perform the related O&M operations on the compute engines.

Item Description References
MaxCompute Click MaxCompute to go to the MaxCompute page to manage the MaxCompute projects. Use MaxCompute Management
Graph Compute Click Graph Compute to go to the Graph Compute page to manage the Graph Compute instances. Compute engine list
Hologres Click Hologres to go to the Hologres console to manage Hologres instances. Compute engine list

Lake and Warehouse Integration (Data Lakehouse)

The lakehouse solution is implemented by integrating MaxCompute with a Hadoop cluster or integrating MaxCompute with Data Lake Formation (DLF) and Object Storage Service (OSS). The lakehouse solution enables you to build a data management platform that integrates data lakes and data warehouses. The lakehouse solution integrates the flexibility and broad ecosystem compatibility of data lakes with the enterprise-class deployment capabilities of data warehouses. For more information, see Lakehouse of MaxCompute.