This topic provides answers to some frequently asked questions about DataService Studio.

Why does DataService Studio fail to connect to a self-managed database that is hosted on an Elastic Compute Service (ECS) instance?

DataService Studio cannot connect to self-managed databases that are hosted on ECS instances by using an internal endpoint.

Do I need to activate the API Gateway service?

API Gateway provides you with API hosting services. If you want your API operations to be available to others, you must activate the API Gateway service.

How do I add a data source?

To add a data source, perform the following steps: Log on to the DataWorks console. Go to the Workspace Management page of the desired workspace. In the left-side navigation pane of the Workspace Management page, click Data Source. In the upper-right corner of the Data Source page, click Add data source. Then, configure the parameters to add a data source. After you add the data source, DataService Studio automatically reads data from the data source. For more information, see Configure a data source.

Can DataService Studio directly read data from MaxCompute?

DataService Studio cannot directly read data from MaxCompute. You can add a Hologres data source and use the accelerated query feature of Hologres to allow DataService Studio to query data in MaxCompute. For more information about how to add a Hologres data source, see Add a Hologres data source.

Hologres provides an efficient and stable real-time data warehousing service. If you use a Lightning data source to read data from a MaxCompute data source, we recommend that you migrate data in the Lightning data source to Hologres.

What is the difference between the codeless UI and the code editor that are used to create an API?

The code editor provides more powerful features than the codeless UI. For more information, see Create an API in the code editor.

What is the role of an API group in DataService Studio? Is an API group in DataService Studio the same as an API group in API Gateway?

An API group is a group of APIs that are specific to a feature or a scenario. An API group is the smallest organization unit in DataService Studio and is similar to an API group in API Gateway. After you publish an API that you created in DataService Studio to API Gateway, API Gateway automatically creates an API group that has the same name.

How do I configure an API group?

In most cases, an API group includes APIs that provide similar features or resolve a specific issue. For example, a weather API group can include the API that is used to check the weather by city and the API that is used to check the weather by longitude and latitude.

How many API groups can I create?

You can create a maximum of 100 API groups within an Alibaba Cloud account.

When do I need to enable the pagination feature to display the returned results on multiple pages?

By default, an API call returns a maximum of 2,000 records. If an API call may return more than 2,000 records, we recommend that you enable the pagination feature. If you do not specify request parameters, the API call returns a large number of records and the pagination feature is automatically enabled.
Note If Pagination is selected on the Response Param tab, the limit that you specify for the number of records to return in the Edit Query SQL section does not take effect. The number of records to return depends on the pagination settings.

Do APIs that are created in DataService Studio support POST requests?

APIs that are created in DataService Studio support GET and POST requests.

Do APIs that are created in DataService Studio support the HTTPS protocol?

APIs that are created in DataService Studio support both the HTTP and HTTPS protocols.

Access to ApsaraDB RDS instances from DataService Studio

When you encapsulate APIs in DataWorks DataService Studio, the prompted suggestions vary based on the data source type that you select when you add a data source. The data source type can be Alibaba Cloud instance mode or connection string mode. This ensures the security of accessing ApsaraDB RDS instances from DataService Studio. The following table describes the prompted suggestions when you encapsulate APIs in DataWorks DataService Studio.
Data source typeScenarioType of resource group for DataService Studio
Exclusive resource group for DataService StudioShared resource group for DataService Studio
Alibaba Cloud Instance ModeAccess ApsaraDB RDS instances within the same tenant.APIs in DataService Studio can be edited and saved.APIs in DataService Studio can be edited and saved.
Access ApsaraDB RDS instances across tenants.APIs in DataService Studio can be edited and saved.An error indicating that security risks exist occurs when you save an API. In this case, you must select an exclusive resource group for DataService Studio. In the right-side navigation pane of the configuration tab of an API, click the Resource Group tab. In the Resource Group panel, select Exclusive Resource Group for DataService Studio for Scheme, select an exclusive resource group for DataService Studio from the Exclusive Resource Group for DataService Studio drop-down list, and then save the API again.
Connection String Mode-APIs in DataService Studio can be edited and saved.An error indicating that security risks exist occurs when you save an API. In this case, you must select an exclusive resource group for DataService Studio. In the right-side navigation pane of the configuration tab of an API, click the Resource Group tab. In the Resource Group panel, select Exclusive Resource Group for DataService Studio for Scheme, select an exclusive resource group for DataService Studio from the Exclusive Resource Group for DataService Studio drop-down list, and then save the API again.
Note If you have purchased an ApsaraDB RDS instance, you can change the data source type from Connection String Mode to Alibaba Cloud Instance Mode. This way, you can use the shared resource group for DataService Studio. For information about how to change the data source type, see Add and manage data sources.