Data sources connect DataV-Board to external storage systems such as databases (MySQL, PostgreSQL), big data storage (TableStore), APIs, and files. Choose a data source type based on your connectivity and access requirements.
Limits
-
Data source support varies by version. For more information, see Specifications.
-
Some data sources have region restrictions. For more information, see Region support.
-
Database data sources must be accessible over the public network. You must also configure an access whitelist. For more information, see Configure a database whitelist.
-
Database data source connections have a 10 second timeout limit.
Choose a data source connection type
Connect to a database
DataV-Board supports connections to self-managed databases. If your database is hosted on a virtual machine or ECS instance, choose a connection type based on public network access:
-
If your database is accessible over the public network: You can use a data source compatible with MySQL databases or the public network connection method for your database (for example, for a public MySQL database, you can select the public network connection method of an RDS for MySQL data source).
-
If public network access is unavailable or not desired: You can use the DataV Proxy Service.
If your SQL query needs to exceed the 10 second timeout limit, you can select the DataV Proxy Service.
Connect to an API
How do you choose between the API, Alibaba Cloud API Gateway, and Open API data source types?
|
Data source type |
Description |
Scenarios |
|
API |
A general data API. |
If you have a ready-to-use API, connect to it using the API data source. Examples include APIs from existing sites or cloud services. For more information about how to use this data source, see Add an API data source. |
|
Alibaba Cloud API Gateway |
An Alibaba Cloud product that provides an API hosting service. |
If the API data source does not support your API logic (for example, custom signature calculation), host your API on Alibaba Cloud API Gateway. DataV-Board then connects through the gateway, which acts as a proxy for your API. For more information about how to use this data source, see Add an Alibaba Cloud API Gateway data source. |
|
Open API |
A method for calling open APIs of Alibaba Cloud products, typically to retrieve product information such as resource status or metrics. |
To retrieve data from Alibaba Cloud products, such as ECS load status or Simple Log Service (SLS) log statistics, use the Open API data source. Open API supports only Alibaba Cloud product APIs. For more information about how to use this data source, see Add an Open API data source. |
DataV-Board cannot directly call all APIs. To work around this, host your API on Alibaba Cloud API Gateway. Common scenarios:
-
If your API uses a custom algorithm for signature authentication, DataV-Board cannot call it directly. Host the API on Alibaba Cloud API Gateway to handle the required authentication logic.
-
If DataV-Board cannot directly access your API (for example, if it is in a VPC), host it on Alibaba Cloud API Gateway.
-
If you do not want to expose the call details of your API, use Alibaba Cloud API Gateway to hide them.
-
If your API uses a data source or interface that DataV-Board does not support, such as Function Compute, use Alibaba Cloud API Gateway to retrieve the data.
List of supported data sources
The following table lists all supported data sources and their connection capabilities.
-
indicates support, and
indicates no support. -
For data sources that require whitelist configuration, you must configure a whitelist for the database to ensure a successful connection.
|
Data source type |
Data source |
Public connection |
VPC connection |
Whitelist configuration |
Remarks |
|
Database |
|
|
|
None. |
|
|
|
|
|
None. |
||
|
|
|
|
If SQL Server is on Microsoft Azure, you must select encrypt. |
||
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
|
|
|
Compatible with earlier MySQL versions. You must enable insecureAuth. Supports Azure Database for MySQL. |
||
|
|
|
|
Domestic database. |
||
|
|
|
|
Domestic database. |
||
|
|
|
|
Domestic database. |
||
|
|
|
|
None. |
||
|
Big data storage |
|
|
|
None. |
|
|
|
|
|
None. |
||
|
|
|
|
None. |
||
|
Files and static data |
Not applicable |
Not applicable |
Not applicable |
The file size cannot exceed 512 KB. |
|
|
Not applicable |
Not applicable |
Not applicable |
JSON data. Available only on the widget data source configuration pane. |
||
|
General API |
|
|
Not applicable |
Supports GET or POST. Available only on the widget data source configuration pane. |
|
|
|
|
Not applicable |
None. |
||
|
|
|
Not applicable |
None. |
||
|
Third-party API |
Not applicable |
Not applicable |
Not applicable |
The DataV Proxy Service is an open source database proxy that you deploy on an ECS instance. It avoids exposing database IP addresses to the public network. For more information about how to deploy and install the DataV Proxy Service, see Configure the DataV Proxy Service. |
|
|
Others |
|
Not applicable |
Not applicable |
None. |
For database data sources, ensure that they are accessible:
-
The database is not blocked by a firewall.
-
The database domain name can be resolved.
Region support
Supported regions for database data sources:
|
Region |
Region ID |
|
China (Hangzhou) |
cn-hangzhou |
|
China (Shanghai) |
cn-shanghai |
|
China (Shenzhen) |
cn-shenzhen |
|
China (Qingdao) |
cn-qingdao |
|
China (Beijing) |
cn-beijing |
|
China (Zhangjiakou) |
cn-zhangjiakou |
|
China (Hohhot) |
cn-huhehaote |
|
China (East) 2 Finance Cloud |
cn-shanghai-finance-1 |
|
China (Shenzhen) Finance Cloud |
cn-shenzhen-finance-1 |
|
China (Hong Kong) |
cn-hongkong |
FAQ
For common questions about data source configuration, see FAQ about data source configuration and use.