使用InvokeDataAPIService調用資料演算法服務API-物聯網平台-阿里雲

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	InvokeDataAPIService	系統規定參數。取值：InvokeDataAPIService。
ApiSrn	String	是	acs:iot::127103983461***:serveapi/device/getDeviceCountByStatus2	API資源標識符，API的全域唯一標識。調用CreateDataAPIService介面成功建立API，返回的ApiSrn值。格式：`acs:iot::${aliyunuserID}:serveapi/${ApiPath}` 樣本：`acs:iot::127103983461**:serveapi/device/getDeviceCountByStatus2` 以上樣本中的資訊說明如下： `127103983461`是阿里雲主帳號ID。 `/device/getDeviceCountByStatus`是請求參數ApiPath**的值，即API調用地址的自訂部分。
Param.N.ParamType	String	否	VARCHAR	資料類型。目前支援類型： VARCHAR INTEGER BOOLEAN BIGINT TIMESTAMP DECIMAL ARRAY 說明 ParamType選擇ARRAY時，ListParamType和ListParamValue參數會生效。 ParamType為其他類型時，ParamValue參數會生效。
Param.N.ListParamValue.N	RepeatList	否	["1","2","3"]	ARRAY類型的參數值列表。數組中只能放置一群組類型相同的資料，例如放置數實值型別資料，則全部資料為數實值型別。說明統一使用String類型儲存，平台會跟據ListParamType對應的值轉換成JDBC類型對象。
Param.N.ListParamType	String	否	VARCHAR	ARRAY類型的參數值的資料類型。目前支援類型： VARCHAR INTEGER BIGINT BOOLEAN DECIMAL TIMESTAMP 具體資訊，請參見JDBCType。
Param.N.ParamName	String	否	status	調用API的入參的參數名稱。必須與調用CreateDataAPIService介面建立API時，RequestParam中定義的Name保持一致。
Param.N.ParamValue	String	否	1	調用API的入參的參數值。統一使用String類型儲存，物聯網平台會根據建立API時定義的ParamType轉換成JDBC類型對象。建立API時，如果API請求參數類型Type定義為ARRAY類型，則不傳入該參數，而需傳入ListParamType和ListParamValue。
IotInstanceId	String	否	iot-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	Success	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的查詢結果。
ApiSrn	String	acs:iot::127103983461***:serveapi/device/getDeviceCountByStatus2	API資源標識符，API的全域唯一標識。樣本：`acs:iot::127103983461*:serveapi/device/getDeviceCountByStatus2` 以上樣本中的資訊說明如下： `127103983461**`是阿里雲主帳號ID。 `/device/getDeviceCountByStatus`是API調用地址的自訂部分。
FieldNameList	List	{"FieldNameList": ["deviceCount"]}	結果欄位列表。列表元素即調用CreateDataAPIService介面建立API時，ResponseParam中的Name定義的參數名稱。
PageNo	Integer	0	顯示的查詢結果的頁碼。分頁碼從0開始，預設為0。如果您要自訂顯示結果頁，建議您在請求參數中增加自訂參數，如pageNo。
PageSize	Integer	1	每頁顯示的查詢結果記錄數。如果您要自訂每頁顯示的記錄數，建議您在請求參數中增加自訂參數，如pageSize。
ResultList	List	[{"deviceCount": 47}]	返回的SQL處理結果。根據調用CreateDataAPIService介面建立API時，ResponseParam中的Name參數，返回處理結果。列表元素`Map<String, Object>`說明如下： key是String類型，是Name定義的參數名稱。 Object是參數對應的值，其資料類型與ResponseParam中的Type一致。
TotalSize	Integer	12	返回的查詢結果總記錄數。
ErrorMessage	String	請求參數錯誤	調用失敗時，返回的出錯資訊。
RequestId	String	E68FE5DC-4D7B-4987-B785-DF8C6F191F5D	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=InvokeDataAPIService
&ApiSrn=acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2
&Param.1.ParamName=status
&Param.1.ParamValue=1
&<公用請求參數>

正常返回樣本

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
}

錯誤碼

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