The IoT Platform DataService Studio defines preset metric APIs that allow users to enable data statistics, instantiate APIs, and access the corresponding data. This topic outlines the steps to view these APIs.
Prerequisites
Ensure product data is backed up. For details, see Data Backup.
Activate the required preset metric data statistics and instantiate API. For guidance, see Enable Specified Preset Metric Data Statistics and Generate Preset Metric Data API.
Procedure
In the IoT Platform console, click Overview. On the Overview tab, find the instance that you want to manage and click the instance ID or the instance name.
Navigate to DataService Studio > Data APIs using the left-side navigation pane.
Select the Preset Metric APIs tab to display all available APIs provided by the IoT Platform.
API paths begin with
${instanceID}/system, where${instanceID}represents the enterprise edition instance ID. This can be found on the IoT Platform's Instance Overview page, under ID.(Optional) To view an API's details, click View in the operation column. This will show the Basic Information, API Monitoring, and Parameters, including system, request, and return parameters.
For additional details, see Management and Usage.
What to do next
Consider instantiating the preset metric table to create additional APIs. For instructions, see Generate Preset Metric Data API.
Utilize the preset metric APIs to monitor the operational status of all devices within the instance.
For examples of API calls, refer to: