Query a Command in the Queue of a Device

Function

Queries a command (in processing) in the queue of a device. The command status can be PENDING, SENT, or DELIVERED. Note that if a command in the DELIVERED status is not updated after a specified period of time (depending on the system configuration), the command will be removed from the queue and changed to a historical command.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v5/iot/{project_id}/devices/{device_id}/async-commands

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
device_id	Yes	String	Parameter description: ID of the device to which the command is delivered. The ID is unique and is allocated by the platform during device registration. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Parameter description: number of records to be displayed on each page. The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. The value is an integer ranging from 0 to 500. The default value is 0. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query.
start_time	No	String	Parameter description: records of command delivered after startTime are queried. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
end_time	No	String	Parameter description: records of command delivered before endTime are queried. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
status	No	String	Parameter description: command status.
command_name	No	String	Parameter description: command name.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
commands	Array of AsyncDeviceListCommand objects	List of device queue commands.
page	QueueCommandPage object	Pagination information of the query results.

**Table 5** AsyncDeviceListCommand
Parameter	Type	Description
device_id	String	A unique device ID is allocated by the platform during device registration.
command_id	String	Device command ID, which is unique and is allocated by the platform during command delivery.
service_id	String	ID of the device service that the device command belongs to, which is defined in the product model associated with the device.
command_name	String	Command name, which is defined in the product model associated with the device.
expire_time	Integer	Duration for the platform to cache commands, in seconds.
status	String	Command status. PENDING: The command is not delivered and is cached on the platform. EXPIRED: The command has expired, that is, the cache time exceeds the value of expire_time. SENT: The command is being delivered. DELIVERED: The command has been delivered. SUCCESSFUL: The command has been executed. FAILED: The command fails to be executed. TIMEOUT: After a command is delivered, no response is received from the device or the response times out.
created_time	String	UTC time when the command was created. The value is in the format of yyyyMMdd'T'HHmmss'Z'.
sent_time	String	UTC time when the platform sent the command. If the command was sent immediately, the value was the same as the command creation time. If the command had been cached, the value was the time when the command was actually sent. The value is in the format of yyyyMMdd'T'HHmmss'Z'.
delivered_time	String	UTC time when the device received the command. The value is in the format of yyyyMMdd'T'HHmmss'Z'.
send_strategy	String	Delivery policy. immediately indicates that the command is delivered immediately. delay indicates that the command is cached and delivered when the device reports data or goes online.
response_time	String	UTC time when the device responded to the command. The value is in the format of yyyyMMdd'T'HHmmss'Z'.

**Table 6** QueueCommandPage
Parameter	Type	Description
count	Long	Total number of records that meet the filter criteria.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

Queries a command in the queue of a device.

GET https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/async-commands

Example Responses

Status code: 200

{
  "commands" : [ {
    "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888",
    "service_id" : "Switch",
    "command_name" : "ON_OFF",
    "expire_time" : 0,
    "status" : "PENDING",
    "created_time" : "20151212T121212Z",
    "sent_time" : "20151212T121212Z",
    "delivered_time" : "20151212T131212Z",
    "send_strategy" : "immediately",
    "response_time" : "20151212T131212Z"
  } ],
  "page" : {
    "count" : 100,
    "marker" : "5c8f3d2d3df1f10d803adbda"
  }
}