GetDeviceShadow_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 500。

说明 RAM 用户共享阿里云账号配额。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot_instc_pu****_c*-v64********
ProductKeystring

要查询的设备所属的产品 ProductKey

示例值:a1T27vz****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
DeviceNamestring

要查询的设备名称。

示例值:device1

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:A56E345A-0978-4993-ACBA-3EF444ED187F
ShadowMessagestring

调用成功时,返回的设备影子信息。展开详情

示例值:{"method":"update","state":{"desired":{"color":"green"}},"version":1}
Successboolean

是否调用成功。展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例

查询IOT设备的运行状态、影子信息
2021-02-28
设备影子功能,用于缓存设备状态。 物联网平台/设备管理/设备/设备详情 (https://iot.console.aliyun.com/devices)
2022-08-08