Queries the tags of a device.
Limits
Each Alibaba Cloud account can run a maximum of 50 queries per second (QPS).
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | QueryDeviceProp | The operation that you want to perform. Set the value to QueryDeviceProp. |
IotInstanceId | String | No | iot_instc_pu****_c*-v64******** | The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console. Important
For more information, see Overview. |
ProductKey | String | No | a1BwAGV**** | The ProductKey of the product to which the device belongs. Note If you specify this parameter, you must also specify the DeviceName parameter. |
DeviceName | String | No | light | The DeviceName of the device. Note If you specify this parameter, you must also specify the ProductKey parameter. |
IotId | String | No | Q7uOhVRdZRRlDnTLv****00100 | The ID of the device. The device ID is issued by IoT Platform. Note If you specify this parameter, you do not need to specify ProductKey or DeviceName. The IotId parameter specifies a globally unique identifier (GUID) of the device, which corresponds to a combination of ProductKey and DeviceName. If you specify both IotId and the combination of ProductKey and DeviceName, IotId takes precedence. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException | The error code returned if the call fails. For more information, see Error codes. |
ErrorMessage | String | A system exception occurred. | The error message returned if the call fails. |
Props | String | {\"coordinate\":\"104.07086:30.549169\"} | A JSON string returned if the call is successful. The JSON string includes the details of the device tags. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | The ID of the request. |
Success | Boolean | true | Indicates whether the call was successful.
|
Examples
Sample requests
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceProp
&ProductKey=a1BwAGV****
&DeviceName=device1
&<Common request parameters>
Sample success responses
XML
format
<QueryDevicePropResponse>
<RequestId>D8CEF5E7-1484-4164-A242-C06BA3A54E0F</RequestId>
<Props>{"coordinate":"104.07086:30.549169"}</Props>
<Success>true</Success>
</QueryDevicePropResponse>
JSON
format
{
"RequestId": "D8CEF5E7-1484-4164-A242-C06BA3A54E0F",
"Props": "{\"coordinate\":\"104.07086:30.549169\"}",
"Success": true
}
Error codes
For a list of error codes, visit the API Error Center.