BatchQueryDeviceDetail

Last Updated on : 2025-10-09 09:26:49Copy for LLMView as MarkdownDownload PDF

You can call this operation to query the details of multiple devices under a specified product.

Instructions for use

A single call can query up to 100 devices.
If the incoming device information contains a device that does not exist, only the details of the existing device are returned.

Request Parameters

Name	Type	Required	Sample Values	Description
Action	String	Yes	BatchQueryDeviceDetail	System defined parameters. Value: BatchQueryDeviceDetail.
DeviceName.N	RepeatList	Yes	Light	The list of device names to query. You can have up to 100 device names.
ProductKey	String	Yes	A1BwAGV * * * *	DeviceName.N of the product to which the device belongs in ProductKey .

Note: When calling an API, in addition to the API-specific request parameters described in this topic, you must also pass in the common request parameters. For more information about common request parameters, see Common parameters.

Return data

Name	Type	Sample Values	Description
Code	String	Iot.system.SystemException	The error code returned when the call fails. For more information, see Error codes.
Data	Array of Data		When the call is successful, the detailed information of the device is returned.
Data
DeviceName	String	Light	The device name.
DeviceSecret	String	No * * * *	The device key.
FirmwareVersion	String	V1.0.0.0	The version number of the default OTA module. To query the version information of other OTA modules reported by the device, seeListOTAModuleVersionsByDevice.
GmtActive	String	2019-06-21 20:33:00	The activation time of the device, in GMT format.
GmtCreate	String	2019-06-21 20:31:42	The creation time of the device, in GMT format.
IoTID	String	**** 00100	The ID issued by IoT platform for the device. The unique identifier of the device.
Nickname	String	Intelligent street lamp	Note name of the device.
NodeType	Integer	0	Node type, value: ●0 : Equipment. The device cannot mount sub-devices. You can connect to the IoT platform directly or as a sub-device of the gateway to connect to the IoT platform. ●1: Gateway. The Gateway can mount sub-devices, have a sub-device management module, maintain the topological relationship of sub-devices, and synchronize the topological relationship to the IoT platform.
ProductKey	String	A1BwAGV * * * *	Of the product to which the device belongs ProductKey .
ProductName	String	Street lamp Products	The name of the product to which the device belongs.
Region	String	Cn-shanghai	The region where the device is located (corresponds to the service region of the IoT Platform on the IoT Platform console).
Status	String	Online	Device status. Value: ●Online : equipment online. ●Offline : The device is offline. ●Unactived : The device is not activated. ●Disable : Device is disabled.
UtcActive	String	2019-06-21 T12:31:42.000Z	The activation time of the device, in UTC format.
UtcCreate	String	2019-06-21 T12:31:42.000Z	The creation time of the device, in UTC format.
ErrorMessage	String	System Exception	Error information returned when the call fails.
RequestID	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	The unique identifier generated for this request.
Success	Boolean	True	Indicates whether the call succeeded. ●True : The call succeeded. ●False : The call failed.

Example

Request Example

curl 'https://si-d6e8******58054.tuyacloud.com:8686/?Action=BatchQueryDeviceDetail&SignatureNonce=6fe7325c88964c3482d16cf6e0742aa8&AccessKeyId=xMr9wgwXQLhv5AUa65o03mcD&DeviceName.1=myTestDevice&SignatureMethod=HMAC-SHA1&Timestamp=2024-11-19T08%3A33%3A46Z&ProductKey=k1ymv1DuLfE&Signature=wNXNCn6Q7311ZyCAu%2BX98jn%2Bjx4%3D'

Normal Return Example

{
	"Data": {
		"Data": [
			{
				"DeviceName": "Humidity",
				"GmtActive": "2020-01-16 13:33:37",
				"ProductKey": "a1ttsqu****",
				"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
				"GmtCreate": "2020-01-08 14:47:08",
				"UtcCreate": "2020-01-08T06:47:08.000Z",
				"IotId": "dwnS41bhNxjslDAIF****00100",
				"Status": "OFFLINE",
				"UtcActive": "2020-01-08T06:47:08.000Z",
				"Region": "cn-shanghai",
				"Nickname": "温湿度",
				"NodeType": 0,
				"ProductName": "光照温湿度传感器"
			},
			{
				"Status": "OFFLINE",
				"GmtActive": "2020-01-17 16:23:15",
				"DeviceName": "TH_sensor",
				"Region": "cn-shanghai",
				"UtcActive": "2020-01-17T03:39:14.000Z",
				"ProductKey": "a1ttsqu****",
				"NodeType": 0,
				"DeviceSecret": "dCYdTU3gw5Z77bsHjPk6lPHPVnBT****",
				"ProductName": "光照温湿度传感器",
				"GmtCreate": "2020-01-17 11:39:14",
				"UtcCreate": "2020-01-17T03:39:14.000Z",
				"IotId": "RKYkCRstfGBh5SZXL****00100"
			}
		]
	},
	"RequestId": "D4C12DD8-4390-4877-B1DC-4049CF4868BC",
	"Success": true
}

Prev DocQueryDeviceDetail

Next DocQueryDevice