调用DescribeDeviceShadow获取设备影子信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDeviceShadow

系统规定参数。取值：DescribeDeviceShadow。

DeviceId String 是 1ac5e182e9634252a02d442a4d5d16fc

设备ID
Path String 是 /

要获取的路径
ProjectId String 是 PIC3UA0V

项目ID
RegionId String 否 cn-shanghai

地域ID
DeviceModel String 否 model_2nd

机型名称
ViewSubscribed Boolean 否 false

是否只查看订阅的信息

返回数据

名称 类型 示例值 描述
DeviceShadow Struct

设备影子信息
DeviceInfo String {\"schema版本\":\"1.0\",\"uuid\":\"002\",\"制造商\":\"0110446as34\",\"对内型号\":\"test_model_product\",\"对外型号\":\"test_model\",\"插件版本号\":{\"插件版本号\":\"1.0\",\"远程控制\":\"1.0\",\"远程诊断\":\"1.0\"},\"数据更新时间\":\"2018-09-14 22:00:01\",\"最近登录账号ID\":\"4***********\",\"系统版本号\":\"1.0.0\",\"设备品牌\":\"003\",\"设备描述\":\"sample desc1\",\"车架号\":\"001\"}

设备信息
DeviceShadow String [{\"id\":10102,\"name\":\"车门:车门\",\"open\":true,\"pId\":101,\"path\":\"/车身与HVAC/车门/车门\"},{\"id\":10101,\"name\":\"锁止状态:1\",\"open\":true,\"pId\":101,\"path\":\"/车身与HVAC/车门/锁止状态\"}]

设备其它信息
RequestId String 6F25F67C-F411-499F-BCE2-67CA563CB064

请求ID

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDeviceShadow
&DeviceId=1ac5e182e9634252a02d442a4d5d16fc
&Path=/
&ProjectId=PIC3UA0V
&<公共请求参数>

正常返回示例

XML格式 

<DeviceShadow>
    <DeviceInfo>{"车架号":"001","对外型号":"test_model","最近登录账号ID":"439********","对内型号":"test_model_product","系统版本号":"1.0.0","数据更新时间":"2018-09-14 21:49:29","制造商":"0110446as34","设备描述":"sample desc1","设备品牌":"003","插件版本号":{"远程诊断":"1.0","远程控制":"1.0","插件版本号":"1.0"},"uuid":"002","schema版本":"1.0"}</DeviceInfo>
    <DeviceShadow>[{"path":"/车身与HVAC/车门/引擎盖状态","name":"引擎盖状态:3","pId":101,"id":10103,"open":true},{"path":"/车身与HVAC/车门/车门","name":"车门:车门","pId":101,"id":10102,"open":true},{"path":"/车身与HVAC/车门/锁止状态","name":"锁止状态:1","pId":101,"id":10101,"open":true}]</DeviceShadow>
</DeviceShadow>
<RequestId>40FE5EA3-F4D3-4D4B-99BD-2F5B7B90DE7E</RequestId>

JSON格式 

{
	"DeviceShadow": {
		"DeviceInfo": "{\"车架号\":\"001\",\"对外型号\":\"test_model\",\"最近登录账号ID\":\"439********\",\"对内型号\":\"test_model_product\",\"系统版本号\":\"1.0.0\",\"数据更新时间\":\"2018-09-14 21:49:29\",\"制造商\":\"0110446as34\",\"设备描述\":\"sample desc1\",\"设备品牌\":\"003\",\"插件版本号\":{\"远程诊断\":\"1.0\",\"远程控制\":\"1.0\",\"插件版本号\":\"1.0\"},\"uuid\":\"002\",\"schema版本\":\"1.0\"}",
		"DeviceShadow": "[{\"path\":\"/车身与HVAC/车门/引擎盖状态\",\"name\":\"引擎盖状态:3\",\"pId\":101,\"id\":10103,\"open\":true},{\"path\":\"/车身与HVAC/车门/车门\",\"name\":\"车门:车门\",\"pId\":101,\"id\":10102,\"open\":true},{\"path\":\"/车身与HVAC/车门/锁止状态\",\"name\":\"锁止状态:1\",\"pId\":101,\"id\":10101,\"open\":true}]"
	},
	"RequestId": "40FE5EA3-F4D3-4D4B-99BD-2F5B7B90DE7E"
}

错误码

访问错误中心查看更多错误码。