获取设备影子

最近更新时间:2019-05-09 19:52:56

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceShadow
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
ProductId String 产品 ID
DeviceName String 设备名称。命名规则:[a-zA-Z0-9:_-]{1,48}

3. 输出参数

参数名称 类型 描述
Data String 设备影子数据
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设备影子

输入示例

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

输出示例

{
  "Response": {
    "Data": "{\"payload\":{\"state\": {\"reported\": { \"color\": \"red\"}}, \"metadata\": {\"reported\": {\"color\": {\"timestamp\": 1509092895971}}}, \"timestamp\": 1509443636326, \"version\": 5},\"result\":0,\"timestamp\":1509440846582,\"type\":\"get\"}",
    "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误
InvalidParameterValue.ParamIncomplete 请求中缺少关键字段信息。
ResourceNotFound.DeviceShadowNotExist 设备影子不存在。
ResourceNotFound.ProductOrDeviceNotExist 用户不存在此产品或设备。