查询设备影子
功能介绍
查询设备影子。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/link/instances/{instance_id}/devices/{device_id}/shadow
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 最小长度:0 最大长度:32 |
instance_id |
是 |
String |
实例的ID。 最小长度:0 最大长度:36 |
device_id |
是 |
Integer |
设备ID。 最小值:0 最大值:99999999999999999 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of ShadowService objects |
OK |
参数 |
参数类型 |
描述 |
---|---|---|
service_id |
Integer |
服务ID。 最小值:1 最大值:99999999999999999 |
service_name |
String |
服务名称。 最小长度:2 最大长度:64 |
properties |
Array of ShadowValue objects |
影子值。 数组长度:1 - 9999 |
参数 |
参数类型 |
描述 |
---|---|---|
property_name |
String |
属性名称。 最小长度:0 最大长度:64 |
property_value |
String |
属性最后一次上报值。 最小长度:0 最大长度:64 |
property_updated_date |
Long |
属性最后一次上报时间,格式timestamp(ms),使用UTC时区。 最小值:1 最大值:99999999999999999 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
请求示例
GET /{project_id}/link/instances/{instance_id}/devices/{device_id}/shadow
响应示例
状态码: 200
OK
[ ]
状态码: 400
Bad Request
{ "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.getDeviceShadow]. Parameter is [deviceOid]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" }
状态码: 404
Not Found
{ "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" }
状态码: 500
Internal Server Error
{ "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。