物联网通信查看设备详情-设备相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： iotcloud.tencentcloudapi.com 。

本接口（DescribeDevice）用于查看设备信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDevice。
Version	是	String	公共参数，本接口取值：2021-04-08。
Region	是	String	公共参数，详见产品支持的地域列表。
ProductId	是	String	产品ID 示例值：ABCDE12345
DeviceName	是	String	设备名示例值：abc

3. 输出参数

参数名称	类型	描述
DeviceName	String	设备名示例值：ABCD
Online	Integer	设备是否在线，0不在线，1在线，3未激活示例值：1
LoginTime	Integer	设备登录时间示例值：1
Version	String	设备固件版本示例值：1.0.0
LastUpdateTime	Integer	设备最后更新时间示例值：1
DeviceCert	String	设备证书示例值：-----BEGIN CERTIFICATE-----IIDS...Fw==-----END CERTIFICATE-----
DevicePsk	String	设备密钥示例值：PSK
Tags	Array of DeviceTag	设备属性
DeviceType	Integer	设备类型示例值：3
Imei	String	国际移动设备识别码 IMEI 示例值：imei
Isp	Integer	运营商类型示例值：1
ConnIP	Integer	IP地址示例值：1
LoraDevEui	String	Lora设备的dev eui 示例值：eui
LoraMoteType	Integer	Lora设备的mote type 示例值：1
LogLevel	Integer	设备的sdk日志等级注意：此字段可能返回 null，表示取不到有效值。示例值：1
FirstOnlineTime	Integer	首次上线时间注意：此字段可能返回 null，表示取不到有效值。示例值：1617801604
LastOfflineTime	Integer	最近下线时间注意：此字段可能返回 null，表示取不到有效值。示例值：1617801604
CreateTime	Integer	设备创建时间注意：此字段可能返回 null，表示取不到有效值。示例值：1617801604
CertState	Integer	设备证书获取状态，0 未获取过设备密钥, 1 已获取过设备密钥注意：此字段可能返回 null，表示取不到有效值。示例值：-----BEGIN CERTIFICATE----- MIIFGjCCBAKgAwIBAgIQCgRw0Ja8ihLIkKbf
EnableState	Integer	设备启用状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
Labels	Array of DeviceLabel	设备标签注意：此字段可能返回 null，表示取不到有效值。
ClientIP	String	MQTT客户端IP地址注意：此字段可能返回 null，表示取不到有效值。示例值：127.0.0.1
FirmwareUpdateTime	Integer	设备固件更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：1617801604
CreateUserId	Integer	创建者账号ID 注意：此字段可能返回 null，表示取不到有效值。示例值：0
NBIoTDeviceID	String	NB IoT运营商处的DeviceID 示例值：1233445
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看设备详情示例

输入示例

https://iotcloud.tencentcloudapi.com/?Action=DescribeDevice
&ProductId=ABCDE12345
&DeviceName=abc
&<公共请求参数>

输出示例

{
    "Response": {
        "EnableState": 1,
        "LastOfflineTime": 1,
        "Version": "2021-04-08",
        "CertState": 1,
        "Online": 1,
        "FirmwareUpdateTime": 1,
        "DeviceName": "Device001",
        "Tags": [
            {
                "Tag": "Key",
                "Type": 1,
                "Name": "Key",
                "Value": "Key"
            },
            {
                "Tag": "tag-a",
                "Type": 1,
                "Name": "tag-name",
                "Value": "tag-value"
            }
        ],
        "LogLevel": 1,
        "FirstOnlineTime": 1,
        "DeviceCert": "******",
        "Imei": "Imei",
        "ClientIP": "127.0.0.1",
        "DevicePsk": "DevicePsk",
        "Isp": 1,
        "NBIoTDeviceID": "123124",
        "LoraDevEui": "your eui",
        "DeviceType": 1,
        "RequestId": "2abji99uojssd88",
        "LoginTime": 1,
        "ConnIP": 1,
        "LastUpdateTime": 1,
        "Labels": [
            {
                "Value": "value-a",
                "Key": "key-a"
            }
        ],
        "CreateTime": 1,
        "LoraMoteType": 1,
        "CreateUserId": 0
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBOperationError	数据库内部错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound.DeviceNotExist	设备不存在。
ResourceNotFound.ProductNotExist	产品不存在。

查看设备详情

本页目录：