Collects Statistics on the Total Number of Historical Commands of a Device
Function
Collects statistics on the total number of historical commands of a device.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v5/iot/{project_id}/devices/{device_id}/async-commands-history/count
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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
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 |
---|---|---|
count |
Long |
Total number of records that meet the filter criteria. |
Example Requests
Collects statistics on the total number of historical commands of a device.
POST https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/async-commands-history/count
Example Responses
Status code: 200
OK
{ "count" : 100 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
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