Configure a workspace

更新时间:
复制 MD 格式

After creating a workspace, ongoing management is essential for its smooth and secure operation. This topic guides you, as a Workspace Administrator, through key management tasks for an existing workspace. These operations include viewing configuration details, modifying basic information, adding data sources, and, when no longer needed, disabling or deleting the workspace.

Permissions

  • Only an Alibaba Cloud account or a RAM user with the AliyunDataWorksFullAccess permission can delete or disable a workspace.

  • Only a Workspace Administrator can modify workspace information, add data sources, and bind compute resources.

Create a workspace

All development occurs within a workspace. Therefore, you must first create a workspace before starting task development.

Configure a workspace

Go to the workspace configuration page

  1. Go to the DataWorks Workspaces page. In the top menu bar of the console, select the desired region.

  2. Find the target workspace and click Operation in the Details column to open the workspace details page.

    You can also click Manage

    Click Workspace in the left-side menu and select a target region, such as China (Hangzhou), in the top region selector to view the list of workspaces. In addition to Details and Manage, the Actions column provides a Quick Entry button and a more actions drop-down menu that contains the Create Data Source, Bind Compute Resource, Delete Workspace, and Disable Workspace options.

Configure basic information

  1. In the General Configurations > General section, view and configure the basic information of the workspace.

    Parameter

    Description

    Workspace ID

    The unique identifier for the workspace. This cannot be modified after creation.

    Workspace Name

    Status

    The status of the workspace. You can manually disable a workspace.

    • Normal: The workspace is running as expected.

    • Disabled: The workspace has been manually disabled.

    • Overdue: The workspace is frozen due to an overdue payment.

    • Other statuses: If an unexpected status appears, contact technical support for assistance.

      If a workspace fails to be created, its status changes to Initialization Failed. You can try to create the workspace again.

    Display Name

    The display name and description that identify the workspace. An account with the Workspace Administrator role can modify these fields.

    Description

    Mode

    When you create a workspace, if you enable Isolate Development and Production Environments, the workspace is in Standard Mode. Otherwise, it is in Basic Mode.

    Important

    A workspace in Basic Mode where the new data development feature is not enabled can be upgraded to Standard Mode. The upgrade option is visible only to the Alibaba Cloud account. Workspaces where the new data development feature is enabled cannot be upgraded at this time. If you need to upgrade, contact technical support. For more information, see Upgrade a workspace mode.

    Owner

    The owner of the workspace, who has permissions to delete or disable it. The owner cannot be modified.

    Schedule PAI Nodes

    To schedule PAI algorithm tasks, you must enable this option. Once enabled, it cannot be disabled.

    If you select Create AI Workspace with Same Name when you create the workspace, this option is enabled by default.
  2. (Optional) In the General Configurations > Individual Development Environment section, configure the auto-shutdown policy for individual development environment instances within the workspace.

    Important

    This feature is available only in some regions. Availability is subject to the console page.

    This option can be configured only for workspaces where the new data development feature is enabled. When a running instance of an individual development environment in the workspace meets the workspace-level auto-shutdown policy, the system automatically shuts it down. For more information, see Set a workspace-level auto-shutdown policy.

    The auto-shutdown policy supports a combination of conditions by using AND logic, such as Idle Time, CPU utilization, and GPU utilization. You can click + Add to include more conditions.

  3. In the General Configurations > Security Settings section, control the basic security operations for the workspace.

    Parameter

    Description

    Download SELECT Result

    Controls whether users can download data query results. If this option is disabled, users cannot download the results of SELECT statements.

    Change Node Owner by RAM User

    Controls whether RAM users can change the owners of their own nodes.

    Sandbox whitelist

    (IP addresses or domain names that Shell tasks can access)

    Defines a whitelist of IP addresses or domain names that Shell tasks can access when running on a shared resource group.

    Important

    You must enter public IP addresses or domain names that can be accessed. For internal services, we recommend that you use an exclusive resource group to ensure network reachability. For more information, see DataWorks resource groups.

Data sources and compute resources

DataWorks supports various compute engines, such as MaxCompute, E-MapReduce, and Realtime Compute for Apache Flink, and allows data synchronization between them. In data development, you can run compute tasks on compute resources such as MaxCompute, Hologres, AnalyticDB for PostgreSQL, AnalyticDB for MySQL, and ClickHouse, and manage the data stored in their respective data sources.

Configure workspace members and roles

In the Workspace Members section, you can add, modify, and remove members and grant them roles. In the Workspace Roles section, you can view and manage the roles within the current workspace.

  1. Add workspace members: When you add a RAM user to the workspace, you must assign them a role. The user then gains the permissions associated with that role. For details, see Add workspace members and manage member role permissions.

    Note

    DataWorks allows you to grant RAM users workspace-level custom roles and preset roles. Custom roles must be defined by a Workspace Administrator in the Workspace Roles section. Different roles have different permissions for workspace modules. For more information, see Workspace-level module permission control.

  2. Manage member roles: View preset or custom roles in the workspace. If preset roles do not meet your business needs, you can create custom roles. You can configure the permissions that a role has for DataWorks workspace modules and configure permission mappings to MaxCompute project roles. For more information about managing workspace role permissions, see Workspace-level module permission control.

    Note

    Only an Alibaba Cloud account or a RAM user who is granted the Admin or Super_Administrator role for a MaxCompute project can configure permission mappings.

  3. View the permission list: On the Permissions tab, you can view the feature permissions for each preset workspace role. For more information, see Appendix: List of permissions for preset roles (workspace level).

Delete or disable workspace

In the Workspaces list on the DataWorks console, click the 更多 icon in the Actions column for the desired workspace, and then select Delete Workspace or Disable Workspace.

  • Delete Workspace: Deleting a workspace also deletes all its development assets, such as code. This action is irreversible. Proceed with caution.

    Important

    Before you delete a workspace, we recommend that you go to Operation Center to suspend or delete related periodic tasks and go to DataService Studio to take offline and delete any published APIs. This prevents further billing after workspace deletion. If billing continues after you delete the workspace, submit a ticket to contact technical support.

  • Disable Workspace:

    • After a workspace is disabled, its scheduled tasks no longer generate new instances. However, instances generated before the workspace was disabled still run at their scheduled times, but you cannot log in to the workspace to check their status.

    • After a workspace is disabled, the compute engine services that it uses remain active and may continue to incur storage fees. These fees are charged by the respective compute engine, not by DataWorks. For questions about storage billing, contact the support team for the relevant compute engine.

Next steps

After activating DataWorks, you must also purchase a resource group to use for data synchronization, data scheduling, or DataService Studio. For more information, see Resource group management.