Configure an API data source
IoT Platform provides an API to import external data. Data imported using this API is referred to as API source data. You can upload data from local systems or other platforms to DataService Studio in IoT Platform for analysis and processing.
Prerequisites
You have an Enterprise Edition instance of IoT Platform. For more information, see Purchase an Enterprise instance.
Procedure
-
In the IoT Platform console, go to the Overview page and click the ID or alias of the target Enterprise Edition instance.
-
In the navigation pane on the left, choose DataService Studio > Data Ingestion, and click the API Data Source tab.
-
On the API Data Source tab, click New API Data Source.
-
In the New API Data Source dialog box, set the following parameters and click Confirm.
Parameter
Description
API data source name
The name can contain Chinese characters, letters, digits, underscores (_), and parentheses (()). Maximum length: 30 characters.
Description
The description of the API data source. Maximum length: 100 characters.
Directly output to a custom storage table
-
Select a storage table.
NoteAfter you attach a storage table, you cannot write data to the table using a data parsing task.
-
No (data must be parsed before it can be written to a table)
Custom storage table
If you set Directly output to a custom storage table to Yes, you must select a custom storage table.
NoteTables that are not initialized or are already in use cannot be selected.
-
-
On the API Data Source tab, find the API data source that you created and click Debug in the Actions column. You are redirected to the OpenAPI Portal, where you can call the AddDataForApiSource operation to import external data to IoT Platform. To view information such as the SDK package and SDK version, click SDK Information on the right side of the page.
Optional operations
After you create a data source, find it on the API Data Source tab and click Edit or Delete in the Actions column.
Operation | Description |
Edit | Modify the configurations of the API data source. All configurations can be modified. |
Delete | Delete the API data source. Important If an API data source is used in the source definition for a data parsing node, deleting the API data source also deletes the data source from the corresponding data parsing node. Perform this operation with caution. For more information, see Configure a source definition. |
What to do next
After you create an API data source, use the data parsing feature to further process, analyze, and use the data. For more information, see Data parsing overview.