# 查询设备影子 - ListShadows
#### 功能介绍
查询设备影子。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ROMA/doc?api=ListShadows)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-roma/roma_06_0018.html)。
#### URI
GET /v2/{project_id}/link/instances/{instance_id}/devices/{device_id}/shadow
表1路径参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                 |
|:---|:---|:---|:---|
| project_id  | 是    | String  | 项目ID。兼容20.0场景默认为default。项目ID，获取方式请参见API参考的"附录 \> 获取项目ID"章节。                                                        |
| instance_id | 是    | String  | 实例的ID。兼容20.0场景默认为default。                                                                                          |
| device_id   | 是    | Integer | 设备ID，该字段为数据库中的自增唯一标识符；通过调用查询设备接口：GET /v2/{project_id}/link/instances/{instance_id}/devices获取响应体中对应设备的device_id字段值。 |
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数       | 参数类型                                                                   | 描述       |
|:---|:---|:---|
| \[数组元素\] | Array of [ShadowService] objects | 设备影子响应列表 |
   
 表4ShadowService 
| 参数           | 参数类型                                                               | 描述                                                                                                                   |
|:---|:---|:---|
| service_id   | Integer                                                            | 服务ID，该字段为数据库中的自增唯一标识符；通过调用查询服务接口：GET /v2/{project_id}/link/instances/{instance_id}/services获取响应体中对应服务的service_id字段值。 |
| service_name | String                                                             | 服务名称。                                                                                                                |
| properties   | Array of [ShadowValue] objects | 影子值。                                                                                                                 |
| type         | String                                                             | 设备影子返回内容所属类型，支持json和text，Site自治版场景使用。                                                                                |
| content      | String                                                             | 设备影子返回值为文本类型时的内容，Site自治版场景使用。                                                                                        |
   
 表5ShadowValue 
| 参数                    | 参数类型   | 描述                                  |
|:---|:---|:---|
| property_name         | String | 属性名称。                               |
| property_value        | String | 属性最后一次上报值。                          |
| property_updated_date | Long   | 属性最后一次上报时间，格式timestamp(ms)，使用UTC时区。 |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
| error_msg  | String | 错误描述。                          |
| request_id | String | 消息ID。                          |
   
**状态码：404**
表7响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
| error_msg  | String | 错误描述。                          |
| request_id | String | 消息ID。                          |
   
**状态码：500**
表8响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| error_code | String | 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 |
| error_msg  | String | 错误描述。                          |
| request_id | String | 消息ID。                          |
   
#### 请求示例
```
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 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-roma/ErrorCode.html)。