調用該接口執行數據服務API對應的查詢任務,從而獲取數據源里的指定數據。
使用限制
每個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為5。
調試
您可以在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 | 是 | = |
比較運算符。 僅支持 您可在數據API的API詳情頁面,查看請求參數的對應操作符。具體操作,請參見查看與使用。
例如,數據集有6條記錄(對應的
說明 如果該參數取值為
BETWEEN ,則Condition.N.BetweenStart和Condition.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取值不為
BETWEEN 或bt 時,該參數必傳,且不傳Condition.N.BetweenStart和Condition.N.BetweenEnd。
|
Condition.N.BetweenStart | String | 否 | 1 |
服務API請求參數表示范圍時的起始值。 您可在數據API的API詳情頁面,查看請求參數的取值范圍。具體操作,請參見查看與使用。 說明 當Condition.N.Operate取值為
BETWEEN 或bt 時,該參數必傳,且不傳Condition.N.Value。
|
Condition.N.BetweenEnd | String | 否 | 5 |
服務API請求參數表示范圍時的終止值。 您可在數據API的API詳情頁面,查看請求參數的取值范圍。具體操作,請參見查看與使用。 說明 當Condition.N.Operate取值為
BETWEEN 或bt 時,該參數必傳,且不傳Condition.N.Value。
|
PageNum | Integer | 否 | 1 |
指定顯示返回結果中的第幾頁的內容。默認值為 1。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | Success |
接口返回碼:
|
Data | Struct |
調用成功時,返回的數據信息。 |
|
Count | Long | 3 |
符合查詢條件的記錄總條數。 |
HasNext | Boolean | 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 |
表示是否調用成功:
|
示例
請求示例
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
}