調用該接口調用數(shù)據算法服務API,獲取SQL查詢結果。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(shù)(QPS)最大限制為1。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | InvokeDataAPIService | 系統(tǒng)規(guī)定參數(shù)。取值:InvokeDataAPIService。 |
ApiSrn | String | 是 | acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2 | API資源標識符,API的全局唯一標識。 調用CreateDataAPIService接口成功創(chuàng)建API,返回的ApiSrn值。 格式: 示例: 以上示例中的信息說明如下:
|
Param.N.ParamType | String | 否 | VARCHAR | 數(shù)據類型。目前支持類型:
說明
|
Param.N.ListParamValue.N | RepeatList | 否 | ["1","2","3"] | ARRAY類型的參數(shù)值列表。數(shù)組中只能放置一組類型相同的數(shù)據,例如放置數(shù)值類型數(shù)據,則全部數(shù)據為數(shù)值類型。 說明 統(tǒng)一使用String類型存儲,平臺會跟據ListParamType對應的值轉換成JDBC類型對象。 |
Param.N.ListParamType | String | 否 | VARCHAR | ARRAY類型的參數(shù)值的數(shù)據類型。 目前支持類型:
具體信息,請參見JDBCType。 |
Param.N.ParamName | String | 否 | status | 調用API的入參的參數(shù)名稱。必須與調用CreateDataAPIService接口創(chuàng)建API時,RequestParam中定義的Name保持一致。 |
Param.N.ParamValue | String | 否 | 1 | 調用API的入參的參數(shù)值。
|
IotInstanceId | String | 否 | iot-v64******** | 實例ID。您可在物聯(lián)網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
調用API時,除了本文介紹的該API的特有請求參數(shù),還需傳入公共請求參數(shù)。公共請求參數(shù)說明,請參見公共參數(shù)文檔。
返回數(shù)據
名稱 | 類型 | 示例值 | 描述 |
Code | String | Success | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Data | Struct | 調用成功時,返回的查詢結果。 |
|
ApiSrn | String | acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2 | API資源標識符,API的全局唯一標識。 示例: 以上示例中的信息說明如下:
|
FieldNameList | List | {"FieldNameList": ["deviceCount"]} | 結果字段列表。 列表元素即調用CreateDataAPIService接口創(chuàng)建API時,ResponseParam中的Name定義的參數(shù)名稱。 |
PageNo | Integer | 0 | 顯示的查詢結果的頁碼。分頁碼從0開始,默認為0。 如果您要自定義顯示結果頁,建議您在請求參數(shù)中增加自定義參數(shù),如pageNo。 |
PageSize | Integer | 1 | 每頁顯示的查詢結果記錄數(shù)。 如果您要自定義每頁顯示的記錄數(shù),建議您在請求參數(shù)中增加自定義參數(shù),如pageSize。 |
ResultList | List | [{"deviceCount": 47}] | 返回的SQL處理結果。根據調用CreateDataAPIService接口創(chuàng)建API時,ResponseParam中的Name參數(shù),返回處理結果。 列表元素
|
TotalSize | Integer | 12 | 返回的查詢結果總記錄數(shù)。 |
ErrorMessage | String | 請求參數(shù)錯誤 | 調用失敗時,返回的出錯信息。 |
RequestId | String | E68FE5DC-4D7B-4987-B785-DF8C6F191F5D | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=InvokeDataAPIService
&ApiSrn=acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2
&Param.1.ParamName=status
&Param.1.ParamValue=1
&<公共請求參數(shù)>
正常返回示例
XML
格式
<InvokeDataAPIServiceResponse>
<RequestId>E68FE5DC-4D7B-4987-B785-DF8C6F191F5D</RequestId>
<Data>
<ApiSrn>acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2</ApiSrn>
<PageSize>1</PageSize>
<PageNo>0</PageNo>
<TotalSize>12</TotalSize>
<FieldNameList>
<FieldNameList>deviceCount</FieldNameList>
</FieldNameList>
<ResultList>
<ResultList>
<deviceCount>47</deviceCount>
</ResultList>
</ResultList>
</Data>
<Success>true</Success>
</InvokeDataAPIServiceResponse>
JSON
格式
{
"RequestId": "E68FE5DC-4D7B-4987-B785-DF8C6F191F5D",
"Data": {
"ApiSrn": "acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2",
"PageSize": 1,
"PageNo": 0,
"TotalSize": 12,
"FieldNameList": {
"FieldNameList": ["deviceCount"]
},
"ResultList": {
"ResultList": [{"deviceCount": 47}]
}
},
"Success": true
}