查看设备详情

最近更新时间:2019-07-24 15:21:25

1. 接口描述

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

本接口(DescribeDevice)用于查看设备信息

默认接口请求频率限制:100次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDevice
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
ProductID String 产品ID
DeviceName String 设备名

3. 输出参数

参数名称 类型 描述
DeviceName String 设备名
Online Integer 设备是否在线,0不在线,1在线
LoginTime Integer 设备登录时间
Version String 设备固件版本
LastUpdateTime Integer 设备最后更新时间
DeviceCert String 设备证书
DevicePsk String 设备密钥
Tags Array of DeviceTag 设备属性
DeviceType Integer 设备类型
Imei String IMEI
Isp Integer 运营商类型
ConnIP Integer IP地址
NbiotDeviceID String NB IoT运营商处的DeviceID
LoraDevEui String Lora设备的dev eui
LoraMoteType Integer Lora设备的mote type
LogLevel Integer 设备的sdk日志等级
注意:此字段可能返回 null,表示取不到有效值。
FirstOnlineTime Integer 首次上线时间
注意:此字段可能返回 null,表示取不到有效值。
LastOfflineTime Integer 最近下线时间
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 设备创建时间
注意:此字段可能返回 null,表示取不到有效值。
CertState Integer 设备证书获取状态,0 未获取过设备密钥, 1 已获取过设备密钥
注意:此字段可能返回 null,表示取不到有效值。
EnableState Integer 设备启用状态
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看设备详情示例

输入示例

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

输出示例

{
  "Response": {
    "Tags": [
      {
        "Tag": "category",
        "Type": 2,
        "Value": ""
      },
      {
        "Tag": "note",
        "Type": 2,
        "Value": ""
      }
    ],
    "DeviceName": "",
    "DeviceCert": "-----BEGIN CERTIFICATE-----\nIIDS...Fw==\n-----END CERTIFICATE-----\n",
    "Online": 0,
    "ConnIP": 0,
    "LoginTime": 0,
    "Version": "",
    "LastUpdateTime": 0,
    "DevicePsk": "",
    "DeviceType": 3,
    "Imei": "",
    "Isp": 0,
    "NbiotDeviceID": "",
    "LoraDevEui": "",
    "LoraMoteType": 0,
    "RequestId": "be69a7a3-7315-40a7-9532-3316e4a3e97e"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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