Query Device List Flexibly

Function

API description

This API is used by an application to query a desired device list using SQL statements.

Constraints

• This API is supported only by Standard and Enterprise editions.

• The maximum TPS for an account to call this API is 1 (one request per second).

SQL-like syntax description

SQL-like statements include select, from, where (optional), order by (optional), and limit clauses (optional). The maximum length is 400 characters. The content in the clause is case sensitive, but keywords in SQL statements are case insensitive.

Example:

select * from device where device_id = 'as********' limit 0,5

SELECT clause

select [field]/[count(*)/count(1)] from device

field indicates the parameter to be obtained. Replace it with the response parameter name. You can also enter an asterisk (*) to obtain all parameters.

To obtain the number of queried devices, use count(*) or count(1).

FROM clause

from device

The parameter following from indicates the name of the resource to be queried. Currently, device is supported.

WHERE clause (optional)

WHERE [condition1] AND [condition2]

Up to five conditions are supported. Conditions cannot be nested. For details about the parameters that support query, see Description of query condition parameters and Supported operators.

AND and OR are supported. For details about the priority, see the standard SQL syntax. By default, the priority of AND is higher than that of OR.

LIMIT clause (optional)

limit [offset,] rows

offset indicates the query offset. rows indicates the maximum number of rows in the query result. Examples:

• limit n ; Example: (select * from device limit 10)

Up to n records can be returned.

• limit m,n; Example: (select * from device limit 20,10) The query offset is m. Up to n records can be returned.

Constraints

The maximum value of offset is 500, and the maximum value of rows is 50. If the limit clause is not specified, limit 10 is used by default.

ORDER BY clause (optional)

This clause is used for customizing sorting. Currently, the marker parameter supports custom sorting.

order by marker [asc]/[desc]

If the clause is not specified, random sorting is used by default.

Description of query condition parameters

Supported operators

SQL restrictions

• like: Only prefix match is supported. Suffix match or wildcard match is not supported. At least four characters must be contained for prefix match. Special characters cannot be contained. Only letters, digits, underscores (_), and hyphens (-) are allowed. The prefix must end with %.

• Only count(*) or count(1) is supported.

• Other SQL statements, such as nested SQL statements, union, join, and alias, are not supported.

• The SQL statement can contain up to 400 characters. Up to five request conditions are supported.

• The condition value cannot be null or an empty string.

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}/search/query-devices

Request Parameters

Response Parameters

Status code: 200

Example Requests

Runs the SQL statement to query all devices.

POST https://{endpoint}/v5/iot/{project_id}/search/query-devices

{
  "sql" : "select * from device"
}

Example Responses

Status code: 200

OK

{
  "devices" : [ {
    "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka",
    "marker" : "5c8f3d2d3df1f10d803adbda",
    "device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "node_id" : "ABC123456789",
    "gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
    "device_name" : "dianadevice",
    "node_type" : "ENDPOINT",
    "fw_version" : "1.1.0",
    "sw_version" : "1.1.0",
    "device_sdk_version" : "1.1.0",
    "product_id" : "b640f4c203b7910fc3cbd446ed437cbd",
    "status" : "INACTIVE",
    "tags" : [ {
      "tag_key" : "testTagName",
      "tag_value" : "testTagValue"
    } ]
  } ]
}

Status Codes

Error Codes

See Error Codes.