Use an exclusive resource group for DataService Studio
You can purchase an exclusive resource group for DataService Studio with specifications that meet your business needs to support high-concurrency and high-frequency API calls. This topic describes how to purchase and use an exclusive resource group for DataService Studio.
If you had not activated DataWorks in any region before June 10, 2024, you can only purchase and use serverless resource groups after activation. You cannot purchase or use legacy resource groups. Existing DataWorks users who need to switch to serverless resource groups can see Switch from legacy resource groups.
Exclusive resource groups for DataService Studio are not recommended
DataWorks no longer recommends exclusive resource groups for DataService Studio. Use serverless resource groups instead. A single serverless resource group supports data synchronization, task scheduling and execution, and API service calls and management — replacing exclusive resource groups for scheduling, exclusive resource groups for Data Integration, exclusive resource groups for DataService Studio, and public resource groups.
Prerequisites
Before you purchase and use an exclusive resource group for DataService Studio:
-
Familiarize yourself with the specifications, performance (queries per second, or QPS, supported by different specifications), and billing details of an exclusive resource group for DataService Studio. This helps you plan the resource group specifications and subscription duration based on your business requirements. For more information, see Billing of exclusive resource groups for DataService Studio.
-
When you purchase an exclusive resource group, you must configure its network settings. You can bind the exclusive resource group to a VPC that can connect to your target data source and a vSwitch in the corresponding zone of the VPC. The system then automatically adds a route to the entire CIDR block of the VPC. This ensures network connectivity between the exclusive resource group and data sources within the VPC environment. To view the network information of your data source, see How do I view the network environment of a data source?.
-
API calls may involve interactions with data sources in different network environments. You must understand how an exclusive resource group for DataService Studio connects to these data sources. For more information, see Network connectivity and whitelist configuration.
Limitations
Exclusive resource groups for DataService Studio are available only in the China (Shanghai) region.
Step 1: Purchase a resource group
-
Log on to the DataWorks console.
-
In the left-side navigation pane, click Resource Group to go to the Resource Groups page. On the Exclusive Resource Group tab, click Create Resource Group for DataService Studio of Old Version to open the purchase page. On the purchase page, configure the parameters based on your business needs. Key parameters are described below.
-
Region and Zone: Select the region where you plan to use this exclusive resource group.
Note-
Zones are distinct physical locations within the same region. Zones in the same region are connected through a low-latency internal network.
-
An exclusive resource group cannot be used across regions. For example, an exclusive resource group in the China (Shanghai) region can be used only by a workspace in the China (Shanghai) region.
-
If you have not previously activated DataWorks in any region, you can purchase and use only serverless resource groups. This is because legacy resource groups are being phased out. For more information about the release of serverless resource groups, see Announcement on the Launch of DataWorks Serverless Resource Groups.
-
-
VPC: From the drop-down list, select the VPC to bind. The list shows all VPCs under your account.
-
vSwitch: From the drop-down list, select a vSwitch within the selected VPC as required.
-
Exclusive Resources for DataService Studio: Select the specifications for the exclusive resource group for DataService Studio based on your requirements.
-
Resource Name: Set a name for the resource group. The name must be unique within your tenant. A duplicate name causes an error.
-
Resource notes: Provide a brief description of the resource group.
You can configure other parameters, such as Billing Cycle, based on your business plan.
-
-
Click Buy Now and complete the payment as prompted. DataWorks then begins to initialize the exclusive resource group. Once the status changes to Running, the resource group appears on the console.
NoteThe initialization of an exclusive resource group takes about 20 minutes. Please wait for the status to update to Running.
After the exclusive resource group appears on the console, you must associate it with a workspace before you can select it in API configurations.
Step 2: Associate a workspace
You must associate an exclusive resource group for DataService Studio with a workspace before you can use it in that workspace. A single exclusive resource group for DataService Studio can be associated with multiple workspaces, but it cannot be used across regions. For example, an exclusive resource group in the China (Shanghai) region can be associated only with workspaces in the China (Shanghai) region. To associate a resource group with a workspace, follow these steps:
-
Log on to the DataWorks console.
-
On the Resource Groups page, on the Exclusive Resource Group tab, find the target resource group and click Associate Workspace in the Actions column.
-
On the Associate Workspace page, find the target workspace and click Bind in the Actions column.
Step 3: Configure network connectivity and whitelists
When you use an exclusive resource group for DataService Studio to access a data source, you must ensure network connectivity between them. DataWorks provides connectivity solutions for various network environments, such as the public internet, Alibaba Cloud VPCs, and on-premises data centers (IDCs). In different scenarios, you may need to add the resource group's IP addresses to your database's whitelist. For more information, see Network connectivity and whitelist configuration.
Step 4: Test network connectivity
After completing the network configuration, test the connectivity between the resource group and the data source.
Log on to the DataWorks console. In the target region, click in the left-side navigation pane. Select a workspace from the drop-down list and click Go to Management Center.
On the Workspace Management page, click Data Sources in the left-side navigation pane to open the data source page.
-
Find the target data source and click Edit in the Operation column.
-
On the Data Services tab, find the target resource group and click Test Connectivity. A status of Connectable indicates a successful connection.
NoteWhen you purchase an exclusive resource group for DataService Studio, you must select the network environment for connection. If your database uses a whitelist, add the required IP addresses to the whitelist. For more information, see Network connectivity and whitelist configuration.
-
Click Complete.
Use an exclusive resource group
Currently, only the Generate API feature in DataService Studio supports exclusive resource groups for DataService Studio.
-
In the Data Services panel, double-click the name of an API in the directory tree to open its configuration page.
-
In the right-side pane, click Resource Group for DataService Studio. Set Scheme to Exclusive Resource Group for DataService Studio, and from the Exclusive Service Resource Group drop-down list, select the desired resource group for API calls. For more information, see Generate an API from a data source (Wizard) and Generate an API in Script Mode.
(Optional) Change resource group zone
To change the zone of a resource group, follow these steps:
-
Log on to the DataWorks console.
-
In the left-side navigation pane, click Resource Group. On the Resource Groups page, on the Exclusive Resource Group tab, find the resource group whose Purpose is Data Services.
-
Click the
icon in the Operation column of the resource group and select Change Zone. The Change Zone for Resource Group dialog box appears. -
In the Change Zone for Resource Group dialog box, select the Current Zone and the Machines. Then, select the New Zone and specify the Number of Machines to Use.
-
Click OK to complete the zone change.
Changing the zone of a resource group may cause the following network changes:
-
Resource group CIDR block: Each zone within a resource group corresponds to an independent CIDR block. Therefore, the CIDR block changes if the set of zones used by the resource group changes.
-
Primary elastic network interface (ENI) IP address: The system assigns a new IP address from the CIDR block of the target zone.
-
ENIs bound to the resource group: If you have added the vSwitch CIDR block to the whitelist, this change has no impact. However, if you have whitelisted the IP addresses of the ENIs bound to the resource group, you must update the whitelist with the new ENI IP addresses.