Query Industrial Device Information

Last Updated on : 2023-06-15 06:00:58

Query the information about a specified industrial device on pages, which can be filtered by conditions.

API address

GET: /v1.1/iot-03/si/devices

Request parameter

Parameter name	Type	Required	Description
tuya_device_id	String	false	The ID of a Tuya device.
device_code	String	false	The code of a specified device.
device_name	String	false	The device name. Fuzzy search is supported.
device_model_code	String	false	The code of a specified device model. Multiple models are separated by a comma (,).
customer_code	String	false	The code of a specified customer.
production_time_start	Long	false	The start time, which can be queried by production time.
production_time_end	Long	false	The end time, which can be queried by production time.
is_online	Boolean	false	Check whether the device is online.
failure	Boolean	false	Indicates whether a failure occurs.
page_no	Integer	false	The current page number. Default value: `1`, which means the first page.
page_size	Integer	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 body.
total	Long	The total quantity.
page_no	Long	The current page number.
has_more	Boolean	Specifies whether to return the next page.

Description of data

Parameter name	Type	Description
real_time_positioning	Boolean	Indicates whether the device can be located in real time.
tuya_product_id	String	Tuya product ID.
is_online	Boolean	Indicates whether a device is online.
device_model_code	String	The code of a specified device model.
gateway_id	String	The gateway ID.
device_name	String	The device name.
running_status	String	The operating status of a device.
daily_running_time	Long	The duration of operation on the day. Unit: milliseconds.
sale_time	Long	The sales time.
customer_code	String	The code of a specified customer.
batch_number	String	The device batch number.
modifier	String	The modifier.
gmt_create	Long	The time when it is created.
gmt_modified	Long	The time when it is updated.
device_type_code	String	The code of a specified device type.
production_time	Long	The production time.
sale_latitude	String	The latitude of a specified sales address.
device_code	String	The unique code of a specified device.
sale_address	String	The detailed sales address.
creator	String	The creator.
tuya_device_id	String	The ID of a Tuya device.
failure	Boolean	Indicates whether a failure occurs.
total_running_time	Long	The total duration of operation. Unit: milliseconds.
is_gateway	Boolean	Specifies whether it is a gateway device.
sale_longitude	String	The longitude of a specified sales address.
is_unbind	Boolean	Indicates whether it is unbound.

Request example

GET: /v1.1/iot-03/si/devices

Return example

{
    "result": {
        "data": [
            {
                "gmt_create": 1638189585900,
                "is_unbind": false,
                "creator": "bay1***",
                "tuya_product_id": "xtc***",
                "batch_number": "1",
                "real_time_positioning": true,
                "modifier": "bay16***",
                "is_gateway": true,
                "production_time": 0,
                "sale_address": "Zhejiang***",
                "gmt_modified": 1638189585900,
                "gateway_id": "vdevo***",
                "running_status": "",
                "tuya_device_id": "vdevo***",
                "device_name": "lqd4-1129-02",
                "sale_longitude": "3***",
                "sale_latitude": "12***",
                "device_type_code": "device",
                "failure": false,
                "device_code": "lq**",
                "is_online": true,
                "customer_code": "VIP001",
                "sale_time": 0,
                "device_model_code": "123"
            }
        ],
        "page_no": 1,
        "total": 1,
        "has_more": false,
        "page_size": 20
    },
    "t": 1638199200623,
    "success": true
}

Error code

For more information, see error code.

Prev DocUpdate Industrial Device

Next DocQuery Latest Alerts