1. 接口描述
接口请求域名： iotcloud.tencentcloudapi.com 。
本接口（UpdateDeviceShadow）用于更新虚拟设备信息。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateDeviceShadow。 |
| Version | 是 | String | 公共参数，本接口取值：2021-04-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProductId | 是 | String | 产品ID 示例值：ABCDE12345 |
| DeviceName | 是 | String | 设备名称 示例值：ABC |
| State | 是 | String | 虚拟设备的状态，JSON字符串格式，由desired结构组成 示例值：xxx |
| ShadowVersion | 是 | Integer | 当前版本号，需要和后台的version保持一致，才能更新成功 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | String | 设备影子数据，JSON字符串格式 示例值：{"payload":{"state": {"desired": { "color": "red"}}, "timestamp" |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新设备影子
输入示例
https://iotcloud.tencentcloudapi.com/?Action=UpdateDeviceShadow
&ProductId=ABCDE12345
&DeviceName=abc
&State={"desired":{"color":"red"}}
&ShadowVersion=1
&<公共请求参数>输出示例
{
"Response": {
"Data": "{\"payload\":{\"state\": {\"desired\": { \"color\": \"red\"}}, \"metadata\": {\"desired\": {\"color\": {\"timestamp\": 1509092895971}}}, \"timestamp\": 1509443636326, \"version\": 5},\"result\":0,\"timestamp\":1509440846582,\"type\":\"update\"}",
"RequestId": "9e574269-093f-4a7f-bf90-24ef80b6528a"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.UpdateVersionNotMatch | 更新版本不匹配。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidJSON | JSON参数非法。 |
| InvalidParameterValue.JSONHasInvalidNode | State JSON对象中包含非法节点。 |
| InvalidParameterValue.JSONSizeExceedLimit | State JSON对象超过大小限制，最大为 8k。 |
| InvalidParameterValue.NotMergeAble | 不可合并。 |
| InvalidParameterValue.PrefixInvalid | prefix不合法。 |
| ResourceNotFound.DeviceShadowNotExist | 设备影子不存在。 |
| ResourceNotFound.ProductOrDeviceNotExist | 用户不存在此产品或设备。 |
