This topic answers frequently asked questions about DataService Studio.
Can DataService Studio connect to a self-managed database on an ECS instance?
Does DataService Studio support MaxCompute (ODPS) data sources?
What are the differences between the codeless UI and the code editor?
What is an API group, and how does it relate to an API group in API Gateway?
How does DataService Studio handle RDS access based on my data source type?
Can DataService Studio connect to a self-managed database on an ECS instance?
No. DataService Studio does not support self-managed databases hosted on ECS instances. Configuring an internal network address causes a network connection error.
To expose your data through an API, add a supported data source on the Workspace Management > Data Source Management page instead. For details, see Configure a data source.
Do I need to activate API Gateway?
Only if you want your API available for public calls. API Gateway provides API hosting services, and DataService Studio publishes APIs to it. Activate the API Gateway service before publishing.
How do I configure a data source?
Configure data sources on the Workspace Management > Data Source Management page. After saving, DataService Studio automatically reads the data source information.
For step-by-step instructions, see Configure a data source.
Does DataService Studio support MaxCompute (ODPS) data sources?
Not directly. To query MaxCompute data, connect through a Hologres data source, which accelerates queries against MaxCompute. For setup instructions, see Configure a Hologres data source.
If you previously connected to MaxCompute using a Lightning data source, migrate to Hologres. Hologres provides more efficient and stable real-time data warehouse performance.
What are the differences between the codeless UI and the code editor?
The code editor has more powerful features. For the full set of code editor capabilities, see Create an API in the code editor.
What is an API group, 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 in DataService Studio and corresponds to an API group in API Gateway.
When you publish an API from DataService Studio to API Gateway, the system automatically creates a group with the same name in API Gateway.
How do I organize APIs into groups?
Put APIs that serve the same purpose or cover related scenarios in the same group. For example, group two APIs together — one that queries weather by city name and another that queries by latitude and longitude — under a group named "Weather Query".
What are the limits for API groups and query results?
Resource | Limit |
API groups per Alibaba Cloud account | 100 |
Query results returned per API call (default) | 2,000 |
When should I enable pagination for query results?
Enable pagination when an API might return more than 2,000 results. By default, an API returns at most 2,000 results per call.
If an API has no request parameters, the system automatically enables pagination, since parameter-free queries typically return large result sets.
If Return Result Paging is enabled under Return Parameters in the right-side navigation bar of the edit page, any limit clause in the Write Query SQL area does not take effect. The Return Result Paging configuration controls the number of results returned, not the SQL limit clause.
Do generated APIs support POST requests?
Yes. Generated APIs support both GET and POST requests.
Do generated APIs support HTTPS?
Yes. Generated APIs support both HTTP and HTTPS.
How does DataService Studio handle RDS access based on my data source type?
When you create an API that accesses an RDS instance, the behavior depends on the data source type and resource group combination. The data source type is set when you add a new data source.
Data source type | Scenario | Exclusive resource group | Shared resource group |
Instance Mode | Same-tenant access | Saves normally | Saves normally |
Instance Mode | Cross-tenant access | Saves normally | Save fails with: "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 an exclusive resource group and save again. |
Connection String Mode | — | Saves normally | Save fails with the same security error. Select an exclusive resource group on the Service Resource Group page and save again. 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 to continue using the shared resource group. |
For information on setting up an exclusive resource group, see Use an exclusive resource group for DataService Studio.