Querying a Device Shadow

Function

URI

GET /v2/{project_id}/link/instances/{instance_id}/devices/{device_id}/shadow

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. The default value is default for compatibility with 20.0.Project ID. For details about how to get the project ID, see "Appendix" > "Obtaining a Project ID" in this document.
instance_id	Yes	String	Instance ID. The default value is default for compatibility with 20.0.
device_id	Yes	Integer	Device ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of ShadowService objects	Device shadow response list.

**Table 4** ShadowService
Parameter	Type	Description
service_id	Integer	Service ID.
service_name	String	Service name.
properties	Array of ShadowValue objects	Shadow value.
type	String	Type of the content returned by the device shadow. The value can be JSON or text. This parameter is used in the Site on-premises edition.
content	String	Response of the device shadow in text. This parameter is used in the Site on-premises edition.

**Table 5** ShadowValue
Parameter	Type	Description
property_name	String	Attribute name.
property_value	String	Last reported value of an attribute.
property_updated_date	Long	Time when an attribute is reported for the last time. The format is timestamp(ms) and the UTC time zone is used.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx.
error_msg	String	Error description.
request_id	String	Message ID.

Example Requests

GET /{project_id}/link/instances/{instance_id}/devices/{device_id}/shadow

Example Responses

Status code: 200

[ ]

Status code: 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"
}

Status code: 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

Status code: 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"
}