Query Monitoring Metrics

Last Updated on : 2023-06-21 07:13:09download

Query the configured product monitoring metrics.

API address

GET: /v1.0/iot-03/si/products/monitor-indicator

Request parameter

Parameter name	Type	IN	Required	Description
tuya_product_id	String	query	false	The ID of a Tuya product.
monitor_type	String	query	false	The type of a specified metric. `core_monitor`: general industrial metric. `energy_collect`: industrial energy consumption metric. `environment`: industrial environment metric. `other`: others.
page_no	Long	query	false	The page number. Default value: `1`, which means the first page.
page_size	Long	query	false	The number of items returned on each page. Default value: `20`. Maximum value: `100`.

Return parameter

Parameter name	Type	Description
result	TyPage	The returned result.

Description of result

Parameter name	Type	Description
page_size	Long	The number of items returned on each page.
data	List	The data.
total	Long	The total number of items.
page_no	Long	The current page number.

Description of data

Parameter name	Type	Description
indicator_id	String	The ID of a specified metric.
tuya_product_id	String	The ID of a Tuya product.
indicator_code	String	The code of a specified metric.
monitor_type	String	The monitoring type.
create_time	Long	The time when it is created.

Request example

GET: /v1.0/iot-03/si/products/monitor-indicator?tuya_product_id=ng****

Return example

{
    "result": {
        "data": [
            {
                "tuya_product_id": "5i****",
                "create_time": 1635678293063,
                "indicator_code": "switch_led",
                "indicator_id": "14****",
                "monitor_type": "energy_collect"
            },
            {
                "tuya_product_id": "5i****",
                "create_time": 1635678159020,
                "indicator_code": "switch_led",
                "indicator_id": "14****",
                "monitor_type": "core_monitor"
            }
        ],
        "page_no": 1,
        "total": 2,
        "page_size": 20
    },
    "t": 1635678589042,
    "success": true
}

Error code

For more information, see error code.

Prev DocDelete Monitoring Metrics

Next DocModify Monitoring Metrics