获取设备影子

最近更新时间:2019-04-30 15:16:14

1. 接口描述

本接口(GetDeviceShadow)用于查询虚拟设备信息。

接口请求域名:iotcloud.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
productID String 产品 ID
deviceName String 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败,详见 公共错误码 页面
codeDesc String 返回码描述
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" ,详见本页面的 模块错误码
data Object 业务返回数据

data 的结构如下:

参数名称 类型 描述
payload Object 设备影子数据
result Int 业务处理结果
timestamp DateTime 服务器处理时间
type String 请求类型

payload 的结构如下:

参数名称 类型 描述
state Object 虚拟设备当前状态
metadata Object 虚拟设备属性的元信息,包括创建时间或者最后修改时间
timestamp DateTime 设备影子最近一次更新时间
version Long 当前虚拟设备的版本号

4. 示例

输入

  https://iotcloud.api.qcloud.com/v2/index.php?Action=GetDeviceShadow
  &deviceName=apple
  &productID=ABCDE12345
  &<公共请求参数>

输出

{
    "data":{
      "payload":{
          "state":{
              "reported":{
                  "red":"red"
              }
          },
          "metadata":{
              "reported":{
                  "red":{
                      "timestamp":1509092895971
                  }
              }
          },
          "timestamp":1509440846572,
          "version":4
      },
      "result":0,
      "timestamp":1509440846582,
      "type":"get"
    },
    "message":"",
    "codeDesc":"Success",
    "code": 0
}

5. 模块错误码

模块错误码 描述
5000 请求中缺少关键字段信息
5001 shadow 不存在
5100 内部服务器错误,请联系技术人员
5101 请求参数非法
5102 用户下不存在此产品或设备