使用CreateDataAPIService建立資料演算法服務API-物聯網平台-阿里雲

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	CreateDataAPIService	系統規定參數。取值：CreateDataAPIService。
ApiPath	String	是	device/getDeviceCountByStatus	API調用地址的自訂部分。作為API資源標識符，需具有全域唯一性。說明 API調用地址的前一段部分由系統產生。
DisplayName	String	是	查詢裝置總數	API的顯示名稱，需具有全域唯一性。僅支援中文漢字、英文字母、數字、底線（_）、串連符（-）、英文圓括弧和空格，長度不超過20個字元。
OriginSql	String	是	SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=1	API對應的原始SQL，指定資料開發的SQL樣式。例如`select count(*) as deviceCount from ${system.device} where status = 1`。其中，`${system.device}`是平台系統的裝置表，具體請參見資料表中的表說明。
TemplateSql	String	是	SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=${status}	服務的模板SQL，即原始SQL的模板化。例如`select count(*) as deviceCount from ${system.device} where status = ${status}`。其中，`${status}`是模板化的參數。支援設定模板參數為動態值。
RequestParam.N.Name	String	否	status	請求參數名稱。例如，`${status}`格式的模板參數，參數名稱就是`status`。
RequestParam.N.Type	String	否	VARCHAR	請求參數類型，請參見JDBCType。目前僅支援： ARRAY VARCHAR INTEGER BIGINT BOOLEAN DECIMAL TIMESTAMP
RequestParam.N.Desc	String	否	裝置狀態	請求參數的描述。
RequestParam.N.Example	String	否	dksiaiek23s	請求參數值樣本。
RequestParam.N.Required	Boolean	否	true	該請求參數是否必填。 true（預設）：必填。 false：非必填。
Desc	String	否	資料分析API	API的描述。
ResponseParam.N.Name	String	否	deviceCount	返回參數名稱。
ResponseParam.N.Type	String	否	INTEGER	返回參數類型，請參見JDBCType。目前僅支援： VARCHAR INTEGER BIGINT BOOLEAN DECIMAL TIMESTAMP
ResponseParam.N.Desc	String	否	裝置總數	返回參數描述。
ResponseParam.N.Example	String	否	100	返回參數值樣本。
ResponseParam.N.Required	Boolean	否	true	該返回參數是否必須返回。 true：必須返回。 false：非必須返回。說明返回參數中，此參數無需處理。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	Success	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回建立的API資訊。
ApiSrn	String	acs:iot::127103983461***:serveapi/device/getDeviceCountByStatus2	API資源標識符，API的全域唯一標識。樣本： `acs:iot::127103983461*:serveapi/device/getDeviceCountByStatus2` 以上樣本中的資訊說明如下： `127103983461**`是阿里雲主帳號ID。 `/device/getDeviceCountByStatus`是請求參數ApiPath的值，即API調用地址的自訂部分。
CreateTime	Long	1557839468865	API的建立時間，單位為毫秒（ms）。
LastUpdateTime	Long	1557839468865	API的最後更新時間，單位為毫秒（ms）。
ErrorMessage	String	請求參數錯誤	調用失敗時，返回的出錯資訊。
RequestId	String	57b144cf-09fc-4916-a272-a62902d5b207	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDataAPIService
&ApiPath=device/getDeviceCountByStatus
&DisplayName=查詢裝置總數
&OriginSql=SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=1
&RequestParam.1.Desc=裝置狀態
&RequestParam.1.Example=dksiaiek23s
&RequestParam.1.Name=status
&RequestParam.1.Required=true
&RequestParam.1.Type=VARCHAR
&ResponseParam.1.Desc=裝置總數
&ResponseParam.1.Example=100
&ResponseParam.1.Name=deviceCount
&ResponseParam.1.Required=true
&ResponseParam.1.Type=INTEGER
&TemplateSql=SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=${status}
&<公用請求參數>

正常返回樣本

XML格式

<CreateDataAPIServiceResponse>
      <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
      <Success>true</Success>
      <Data>
            <ApiSrn>acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2</ApiSrn>
            <CreateTime>1557839468865</CreateTime>
            <LastUpdateTime>1557839468865</LastUpdateTime>
      </Data>
</CreateDataAPIServiceResponse>

JSON格式

{
    "RequestId": "57b144cf-09fc-4916-a272-a62902d5b207", 
    "Success": true, 
    "Data": {
        "ApiSrn": "acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2", 
        "CreateTime": 1557839468865, 
        "LastUpdateTime": 1557839468865
    }
}

錯誤碼

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