調(diào)用該接口執(zhí)行數(shù)據(jù)服務(wù)API對(duì)應(yīng)的查詢?nèi)蝿?wù),從而獲取數(shù)據(jù)源里的指定數(shù)據(jù)。
使用限制
每個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)(QPS)最大限制為5。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱(chēng) | 類(lèi)型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListAnalyticsData |
系統(tǒng)規(guī)定參數(shù)。取值:ListAnalyticsData。 |
ApiPath | String | 是 | /iot-cn-npk1v******/system/query/hist_dev_cnt_stat |
API路徑。 您可在數(shù)據(jù)API的API詳情頁(yè)面,查看API Path的值。具體操作,請(qǐng)參見(jiàn)查看與使用。 |
Condition.N.FieldName | String | 是 | testCode |
對(duì)應(yīng)服務(wù)API設(shè)置的請(qǐng)求參數(shù)名。 您可在數(shù)據(jù)API的API詳情頁(yè)面,查看請(qǐng)求參數(shù)的值。具體操作,請(qǐng)參見(jiàn)查看與使用。 |
Condition.N.Operate | String | 是 | = |
比較運(yùn)算符。 僅支持 您可在數(shù)據(jù)API的API詳情頁(yè)面,查看請(qǐng)求參數(shù)的對(duì)應(yīng)操作符。具體操作,請(qǐng)參見(jiàn)查看與使用。
例如,數(shù)據(jù)集有6條記錄(對(duì)應(yīng)的
說(shuō)明 如果該參數(shù)取值為
BETWEEN ,則Condition.N.BetweenStart和Condition.N.BetweenEnd必傳。如果該參數(shù)取值不為BETWEEN ,則Condition.N.Value必傳。
|
IotInstanceId | String | 是 | iot-cn-npk1u****** |
API所在實(shí)例的實(shí)例ID。 更多信息,請(qǐng)參見(jiàn)如何獲取實(shí)例ID。 |
IsoId | String | 否 | oxs_iso_id |
邏輯隔離ID。請(qǐng)忽略該參數(shù)。 |
PageSize | Integer | 否 | 100 |
每頁(yè)顯示結(jié)果的條數(shù)。 返回結(jié)果中,每頁(yè)顯示的記錄數(shù)量。最大取值100,最小取值1,默認(rèn)取值為100。 說(shuō)明 開(kāi)啟分頁(yè)時(shí)必傳。
|
Condition.N.Value | String | 否 | 4 |
比較值。即服務(wù)API請(qǐng)求參數(shù)的賦值。 您可在數(shù)據(jù)API的API詳情頁(yè)面,查看請(qǐng)求參數(shù)的賦值情況。具體操作,請(qǐng)參見(jiàn)查看與使用。 說(shuō)明 當(dāng)Condition.N.Operate取值不為
BETWEEN 或bt 時(shí),該參數(shù)必傳,且不傳Condition.N.BetweenStart和Condition.N.BetweenEnd。
|
Condition.N.BetweenStart | String | 否 | 1 |
服務(wù)API請(qǐng)求參數(shù)表示范圍時(shí)的起始值。 您可在數(shù)據(jù)API的API詳情頁(yè)面,查看請(qǐng)求參數(shù)的取值范圍。具體操作,請(qǐng)參見(jiàn)查看與使用。 說(shuō)明 當(dāng)Condition.N.Operate取值為
BETWEEN 或bt 時(shí),該參數(shù)必傳,且不傳Condition.N.Value。
|
Condition.N.BetweenEnd | String | 否 | 5 |
服務(wù)API請(qǐng)求參數(shù)表示范圍時(shí)的終止值。 您可在數(shù)據(jù)API的API詳情頁(yè)面,查看請(qǐng)求參數(shù)的取值范圍。具體操作,請(qǐng)參見(jiàn)查看與使用。 說(shuō)明 當(dāng)Condition.N.Operate取值為
BETWEEN 或bt 時(shí),該參數(shù)必傳,且不傳Condition.N.Value。
|
PageNum | Integer | 否 | 1 |
指定顯示返回結(jié)果中的第幾頁(yè)的內(nèi)容。默認(rèn)值為 1。 |
調(diào)用API時(shí),除了本文介紹的該API的特有請(qǐng)求參數(shù),還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明,請(qǐng)參見(jiàn)公共參數(shù)文檔。
返回?cái)?shù)據(jù)
名稱(chēng) | 類(lèi)型 | 示例值 | 描述 |
---|---|---|---|
Code | String | Success |
接口返回碼:
|
Data | Struct |
調(diào)用成功時(shí),返回的數(shù)據(jù)信息。 |
|
Count | Long | 3 |
符合查詢條件的記錄總條數(shù)。 |
HasNext | Boolean | false |
符合條件的數(shù)據(jù)是否有下一頁(yè):
|
PageNum | Integer | 1 |
分頁(yè)的頁(yè)碼。 |
PageSize | Integer | 100 |
每頁(yè)顯示結(jié)果的最大條數(shù)。 |
ResultJson | String | [{\"testCode\":\"TBB186\",\"testLevel\":5,\"testWorkYears\":3,\"testName\":\"王五\"},{\"testCode\":\"TBB1314\",\"testLevel\":2,\"testWorkYears\":4,\"testName\":\"李四\"},{\"testCode\":\"TBB8888\",\"testLevel\":2,\"testWorkYears\":5,\"testName\":\"熊大\"}]" |
符合條件的數(shù)據(jù)詳情。 |
ErrorMessage | String | insuficient auth:無(wú)訪問(wèn)權(quán)限 |
調(diào)用失敗時(shí),返回的錯(cuò)誤信息。 |
RequestId | String | 7EC5B624-AF1B-4C4D-BA82-A02BA1****** |
阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。 |
Success | Boolean | false |
表示是否調(diào)用成功:
|
示例
請(qǐng)求示例
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******
&<公共請(qǐng)求參數(shù)>
正常返回示例
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
}