全部產品
Search
文件中心

IoT Platform:進階搜尋

更新時間:Oct 25, 2024

當您需要在物聯網平台搜尋並下載指定條件的裝置列表(包含ProductKeyDeviceName)時,可以使用進階搜尋功能,通過類SQL語句快速搜尋滿足指定條件的裝置,例如線上裝置。本文介紹進階搜尋操作,以及使用的類SQL文法。

使用限制

  • 支援地區:華東2(上海)、日本(東京)

  • 功能限制:在公用執行個體的裝置管理 > 裝置頁面不支援進階搜尋

應用情境

物聯網平台控制台的以下使用情境支援進階搜尋:

  • 查看裝置資訊:在裝置管理 > 裝置頁面的進階搜尋頁簽,從裝置列表搜尋出指定裝置進行管理。

您也可以調用QueryDeviceBySQL API進行裝置進階搜尋。使用API進行進階搜尋時,不局限於以上控制台使用情境。

操作步驟

本文以使用進階搜尋功能向裝置分組添加裝置、在裝置管理中通過物模型搜尋裝置為例,介紹物聯網平台控制台的裝置進階搜尋操作。

  1. 登入物聯網平台控制台

  2. 執行個體概覽頁簽的全部環境下,找到對應的執行個體,單擊執行個體卡片。

  3. 在左側導覽列,選擇裝置管理 > 裝置,單擊進階搜尋頁簽。

  4. 進階搜尋頁簽,通過進階搜尋功能,搜尋符合條件裝置。

    進階搜尋

類SQL文法說明

在控制台使用進階搜尋功能時,類SQL語句由WHERE子句、ORDER BY子句(可選)組成,省略SELECT子句、LIMIT子句以及WHERE子句的WHERE。長度限制為400個字元。

樣本:

product_key = "a1*****" order by active_time

WHERE子句

格式:

[condition1] AND [condition2] 

省略WHERE

最多使用5個condition,且不支援嵌套,請參見下面的檢索欄位說明、運算子說明。

串連詞支援AND、OR,最多使用5個串連詞。

ORDER BY子句(可選)

ORDER BY子句用來實現自訂排序,可自訂排序的欄位包括gmt_creategmt_modifiedactive_time

該子句可不填,不填時隨機排序。

檢索欄位說明

欄位名

類型

說明

product_key

text

裝置所屬產品ProductKey

iot_id

text

裝置標識符。預設返回iot_id

name

text

裝置名稱。

active_time

date

裝置啟用時間。格式為yyyy-MM-dd HH:mm:ss.SSS,精確到毫秒。

nickname

text

裝置備忘名稱。

gmt_create

date

裝置建立時間。格式為yyyy-MM-dd HH:mm:ss.SSS,精確到毫秒。

gmt_modified

date

裝置的備忘名稱最後一次更新時間。格式為yyyy-MM-dd HH:mm:ss.SSS,精確到毫秒。

status

text

裝置狀態,取值:

  • ONLINE:線上

  • OFFLINE:離線

  • UNACTIVE:未啟用

  • DISABLE:已禁用

group.group_id

text

裝置分組ID。

tag.tag_name

text

裝置標籤名。

tag.tag_value

text

裝置標籤值。

ota_module.name

text

OTA模組名稱。

建議與ota_module.version配合使用,用於指定裝置當前OTA版本號碼對應的OTA模組。

ota_module.version

text

裝置當前OTA版本號碼。

建議與ota_module.name配合使用。

運算子說明

運算子

支援的欄位數實值型別

=

number、date、text、keyword

>

number、date

<

number、date

LIKE

text

其中,LIKE支援首碼匹配,不支援尾碼匹配或萬用字元匹配。首碼必須滿足以下條件:

  • 首碼不得少於4個字元,且不能包含任何特殊字元,例如反斜線(\)、正斜線(/)、and(&)、加號(+)、短劃線(-)、驚嘆號(!)、半形圓括弧(())、半形冒號(:)、波浪線(~)、方括弧([])、大括弧({})、星號(*)、半形問號(?)等。

  • 首碼填寫完成後,必須固定以%結尾。

樣本:

product_key = "a1*********" and name LIKE "test%"

相關API

QueryDeviceBySQL:通過類SQL語句快速搜尋滿足指定條件的裝置。