灵活搜索设备列表

功能介绍

接口说明

应用服务器使用SQL语句调用该接口，灵活的搜索所需要的设备资源列表

限制

• 仅标准版实例、企业版实例支持该接口调用，基础版不支持。

• 单账号调用该接口的 TPS 限制最大为1/S(每秒1次请求数)

类SQL语法使用说明

类SQL语句由select、from、where(可选)、order by(可选)、limit子句(可选)组成，长度限制为400个字符。子句里的内容大小写敏感，SQL语句的关键字大小写不敏感。

示例：

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

SELECT子句

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

其中field为需要获取的字段，请参考响应参数字段名称，也可填*，获取所有字段。

如果需要统计搜索的设备个数，请填count(*)或者count(1).

FROM子句

from device

from后为要查询的资源名，当前支持"device"

WHERE子句(可选)

WHERE [condition1] AND [condition2]

最多支持5个condition，不支持嵌套；支持的检索字段请参见下面的搜索条件字段说明和支持的运算符章节

连接词支持AND、OR，优先级参考标准SQL语法，默认AND优先级高于OR。

LIMIT子句(可选)

limit [offset,] rows

offset标识搜索的偏移量，rows标识返回搜索结果的最大行数，例如：

• limit n ;示例(select * from device limit 10)

  最大返回n条结果数据

• limit m,n; 示例(select * from device limit 20,10)

  搜索偏移量为m，最大返回n条结果数据

限制

offset 最大 500， rows最大50，如果不填写limit子句，默认为limit 10

ORDER BY子句(可选)

用于实现自定义排序，当前支持自定义排序的字段为："marker"。

order by marker [asc]/[desc]

子句不填写时默认逻辑为随机排序

搜索条件字段说明

支持的运算符

SQL 限制

• like: 只支持前缀匹配，不支持后缀匹配或者通配符匹配。前缀匹配不得少于4个字符，且不能包含任何特殊字符(只允许中文、字母、数字、下划线（_）、连接符（-）). 前缀后必须跟上"%"结尾。

• 不支持除了count(*)/count(1)以外的其他任何函数。

• 不支持其他SQL用法，如嵌套SQL、union、join、别名(Alias)等用法

• SQL长度限制为400个字符，单个请求条件最大支持5个。

• 不支持"null"和空字符串等条件值匹配

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/search/query-devices

请求参数

响应参数

状态码： 200

请求示例

通过sql查询设备，查询所有设备。

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

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

响应示例

状态码： 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"
    } ]
  } ]
}

状态码

错误码

请参见错误码。