1. API Description
Domain name for API request: iotcloud.tencentcloudapi.com.
This API is used to get the list of IoT Hub devices.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDevices. |
| Version | Yes | String | Common Params. The value used for this API: 2021-04-08. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProductId | Yes | String | ID of the product whose devices are queried |
| Offset | Yes | Integer | Offset, which starts from 0 |
| Limit | Yes | Integer | Page size. Value range: 10-250 |
| FirmwareVersion | No | String | Device firmware version. If no value is passed in, devices of all firmware versions are returned. If None-FirmwareVersion is passed in, devices without version numbers are returned. |
| DeviceName | No | String | Device name to query |
| EnableState | No | Integer | Whether to query enabled or disabled devices. 0: disabled devices; 1: enabled devices. By default, both enabled and disabled devices are queried. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of the devices returned |
| Devices | Array of DeviceInfo | List of device details |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Getting the device list
Input Example
https://iotcloud.tencentcloudapi.com/?Action=DescribeDevices
&ProductId=ABCDE12345
&Offset=0
&Limit=10
&FirmwareVersion=1.0.0
&<Common request parameters>
Output Example
{
"Response": {
"TotalCount": 1,
"RequestId": "xx",
"Devices": [
{
"EnableState": 1,
"LastOfflineTime": 1,
"Version": "xx",
"CertState": 1,
"Online": 1,
"FirmwareUpdateTime": 1,
"DeviceName": "xx",
"Tags": [
{
"Tag": "xx",
"Type": 1,
"Name": "xx",
"Value": "xx"
},
{
"Tag": "xx",
"Type": 1,
"Name": "xx",
"Value": "xx"
}
],
"LogLevel": 1,
"FirstOnlineTime": 1,
"DeviceCert": "xx",
"Imei": "xx",
"ClientIP": "xx",
"DevicePsk": "xx",
"Isp": 1,
"NbiotDeviceID": "xx",
"LoraDevEui": "xx",
"DeviceType": 1,
"LoginTime": 1,
"ConnIP": 1,
"LastUpdateTime": 1,
"Labels": [
{
"Value": "xx",
"Key": "xx"
}
],
"CreateTime": 1,
"LoraMoteType": 1
}
]
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InternalError.DBOperationError | An internal database error occurred. |
| InvalidParameterValue | Invalid parameter value. |
| ResourceNotFound.ProductNotExist | The product does not exist. |
是
否
本页内容是否解决了您的问题？