Query a Command with a Specific ID
Function
This API is used to query a command with a specific ID.
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/{command_id}
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. |
command_id |
Yes |
String |
Parameter description: command ID, which uniquely identifies a message. The value of this parameter is allocated by the platform during command delivery. Value: The value can contain a maximum of 100 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
Request 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
Parameter |
Type |
Description |
---|---|---|
device_id |
String |
Unique device ID, which 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. |
paras |
Object |
Command executed by the device. The command is in JSON format (key-value pairs). If service_id is specified, each key is a paraName in commands in the product model. If service_id is left empty, custom command format is used. {"value":"1"} is an example device command. The specific format depends on the application and 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. |
result |
Object |
Detailed command execution result, which is returned by the device in JSON format. |
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'. |
Example Requests
Querying a command with a specific ID.
GET https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id}
Example Responses
Status code: 200
OK
{ "device_id" : "c1224afb-e9f0-4916-8220-b6bab568e888", "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "service_id" : "Switch", "command_name" : "ON_OFF", "paras" : { "value" : "ON" }, "expire_time" : 0, "send_strategy" : "immediately", "created_time" : "20151212T121212Z", "status" : "DELIVERED", "result" : { "code" : 200 }, "sent_time" : "20151212T121212Z", "delivered_time" : "20151212T121212Z", "response_time" : "20151212T131312Z" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot