This topic answers frequently asked questions about DataService Studio.
Why does DataService Studio fail to connect to a self-managed database that is hosted on an ECS instance?
DataService Studio does not support self-managed databases on ECS instances. A network connection error occurs if you configure an internal network address.
Do I need to activate API Gateway?
API Gateway provides API hosting services. If you want to make your API available for public calls, you must first activate the API Gateway service.
How do I configure a data source?
You can configure data sources on the page. After configuration, DataService Studio automatically reads the data source information. For more information, see Configure a data source.
Does DataService Studio support MaxCompute (ODPS) data sources?
DataService Studio does not directly support MaxCompute (ODPS) data sources. You need to connect to and accelerate queries of MaxCompute data sources using a Hologres data source. For more information about Hologres data sources, see Configure a Hologres data source.
Hologres provides a more efficient and stable real-time data warehouse service. If you connected to a MaxCompute data source using a Lightning data source in an earlier version, migrate it to Hologres.
What are the functional differences between creating an API in the codeless UI and in the code editor?
The code editor has more powerful features. For more information, see Create an API in the code editor.
What is the purpose of an API group in DataService Studio, and how does it relate to an API group in API Gateway?
An API group is a collection of APIs for a specific feature or scenario. It is the smallest organizational unit for APIs in DataService Studio and corresponds to an API group in API Gateway. When an API from DataService Studio is published to API Gateway, the system automatically creates a group with the same name in API Gateway.
How do I properly configure an API group?
Typically, APIs that serve the same purpose or have similar features are placed in the same group. For example, you can place two APIs, one for querying weather by city name and another for querying by latitude and longitude, into an API group named "Weather Query".
What is the maximum number of API groups that I can create?
You can create a maximum of 100 API groups under a single Alibaba Cloud account.
When should I enable pagination for API query results?
By default, an API returns a maximum of 2,000 query results. If an API might return more than 2,000 results, you must enable the pagination feature. If an API has no request parameters, it usually returns many results, and the system automatically enables pagination.
If Return Result Paging is enabled for a DataService Studio API under Return Parameters on the right-side navigation bar of the edit page, and you use an SQL statement to configure a limit clause in the Write Query SQL area, the limit clause does not take effect. The number of returned results is determined by the Return Result Paging configuration.
Do generated APIs support POST requests?
Generated APIs support GET and POST requests.
Do generated APIs support the HTTPS protocol?
Generated APIs support the HTTP and HTTPS protocols.
Accessing RDS instances from DataService Studio
When you create APIs in DataWorks DataService Studio to access RDS instances, the system provides different prompts to ensure security. These prompts depend on the data source type (Instance Mode or Connection String Mode) that you select when you add a new data source. The following table provides the details:
Data source type | Scenario | Type of resource group for DataService Studio | |
Exclusive resource group for DataService Studio | Shared resource group for DataService Studio | ||
Instance Mode | Access RDS instances within the same tenant | You can edit and save the DataService Studio API normally. | You can edit and save the DataService Studio API normally. |
Access RDS instances across tenants | You can edit and save the DataService Studio API normally. | When you save the API, the system reports the following error: "A security risk exists. An exclusive resource group for DataService Studio is required." On the Service Resource Group page in the right-side navigation pane, select the exclusive resource group for DataService Studio and save the API again. Note We recommend using an exclusive resource group for DataService Studio. | |
Connection String Mode | - | You can edit and save the DataService Studio API normally. | When you save the API, the system reports the following error: "A security risk exists. An exclusive resource group for DataService Studio is required." On the Service Resource Group page in the right-side navigation pane, select the exclusive resource group for DataService Studio and save the API again. Note If you have purchased an Alibaba Cloud RDS instance, you can change the data source type from Connection String Mode to Instance Mode in Data Source Management. This lets you continue using the shared resource group for DataService Studio. |