全部產品
Search
文件中心

IoT Platform:ListAnalyticsData

更新時間:Feb 14, 2025

調用該介面執行資料服務API對應的查詢任務,從而擷取資料來源裡的指定資料。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為5。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String ListAnalyticsData

系統規定參數。取值:ListAnalyticsData。

ApiPath String /iot-cn-npk1v******/system/query/hist_dev_cnt_stat

API路徑。

您可在資料API的API詳情頁面,查看API Path的值。具體操作,請參見查看與使用

Condition.N.FieldName String testCode

對應服務API設定的請求參數名。

您可在資料API的API詳情頁面,查看請求參數的值。具體操作,請參見查看與使用

Condition.N.Operate String =

比較子。

僅支援bteqneqrlikeinnin,及其對應的操作符BETWEEN=!=LIKEINNIN

您可在資料API的API詳情頁面,查看請求參數的對應操作符。具體操作,請參見查看與使用

  • BETWEEN:請求參數賦值為特定範圍。
  • =:請求參數賦值為特定值。
  • !=:請求參數賦值不為特定值。
  • LIKE:請求參數賦值以特定值為首。
  • IN:請求參數賦值屬於特定集合。
  • NIN:請求參數賦值不屬於特定集合。

例如,資料集有6條記錄(對應的time分別為abcdabceabcfabcgaabcabbc),調用該介面時,Condition.N.FieldName="time"

  • 如果Condition.N.Operate="LIKE"Condition.N.Value="abc",則返回time=abcdtime=abcetime=abcftime=abcg的所有記錄。
  • 如果Condition.N.Operate="IN"Condition.N.Value="[abcd,abce,abcf]",則返回time=abcdtime=abcetime=abcf的所有記錄。
說明 如果該參數取值為BETWEEN,則Condition.N.BetweenStartCondition.N.BetweenEnd必傳。如果該參數取值不為BETWEEN,則Condition.N.Value必傳。
IotInstanceId String iot-cn-npk1u******

API所在執行個體的執行個體ID。

更多資訊,請參見如何擷取執行個體ID

IsoId String oxs_iso_id

邏輯隔離ID。請忽略該參數。

PageSize Integer 100

每頁顯示結果的條數。

返回結果中,每頁顯示的記錄數量。最大取值100,最小取值1,預設取值為100。

說明 開啟分頁時必傳。
Condition.N.Value String 4

比較值。即服務API請求參數的賦值。

您可在資料API的API詳情頁面,查看請求參數的賦值情況。具體操作,請參見查看與使用

說明 Condition.N.Operate取值不為BETWEENbt時,該參數必傳,且不傳Condition.N.BetweenStartCondition.N.BetweenEnd
Condition.N.BetweenStart String 1

服務API請求參數表示範圍時的起始值。

您可在資料API的API詳情頁面,查看請求參數的取值範圍。具體操作,請參見查看與使用

說明 Condition.N.Operate取值為BETWEENbt時,該參數必傳,且不傳Condition.N.Value
Condition.N.BetweenEnd String 5

服務API請求參數表示範圍時的終止值。

您可在資料API的API詳情頁面,查看請求參數的取值範圍。具體操作,請參見查看與使用

說明 Condition.N.Operate取值為BETWEENbt時,該參數必傳,且不傳Condition.N.Value
PageNum Integer 1

指定顯示返回結果中的第幾頁的內容。預設值為 1。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String Success

介面返回碼:

  • Success:表示成功。
  • 其他:表示錯誤,更多資訊,請參見錯誤碼
Data Struct

調用成功時,返回的資料資訊。

Count Long 3

符合查詢條件的記錄總條數。

HasNext Boolean false

合格資料是否有下一頁:

  • true:有。
  • false:沒有。
PageNum Integer 1

分頁的頁碼。

PageSize Integer 100

每頁顯示結果的最大條數。

ResultJson String [{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"王五\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"李四\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"熊大\"}]"

合格資料詳情。

ErrorMessage String insuficient auth:無存取權限

調用失敗時,返回的錯誤資訊。

RequestId String 7EC5B624-AF1B-4C4D-BA82-A02BA1******

阿里雲為該請求產生的唯一識別碼。

Success Boolean false

表示是否調用成功:

  • true:調用成功。
  • false:調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListAnalyticsData
&ApiPath=/iot-cn-npk1v******/system/query/hist_dev_cnt_stat
&Condition.1.FieldName=testCode
&Condition.1.Operate==
&IotInstanceId=iot-cn-npk1u******
&<公用請求參數>

正常返回樣本

XML格式

<ListAnalyticsDataResponse>
  <RequestId> 7EC5B624-AF1B-4C4D-BA82-A02BA1******</RequestId>
  <Data>
        <ResultJson>[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"王五\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"李四\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"熊大\"}]"</ResultJson>
        <PageSize>100</PageSize>
        <PageNum>1</PageNum>
        <Count>3</Count>
        <HasNext>false</HasNext>
  </Data>
  <Code>Success</Code>
  <Success>true</Success>
</ListAnalyticsDataResponse>

JSON格式

{
    "RequestId": "7EC5B624-AF1B-4C4D-BA82-A02BA1******",
    "Data": {
        "ResultJson": "[{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"王五\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"李四\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"熊大\"}]",
        "PageSize": 100,
        "PageNum": 1,
        "Count": 3,
        "HasNext": false
    },
    "Code": "Success",
    "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。