調用該接口創建數據算法服務API。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為1。
調試
您可以在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樣式。 例如 |
TemplateSql | String | 是 | SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=${status} | 服務的模板SQL,即原始SQL的模板化。 例如 |
RequestParam.N.Name | String | 否 | status | 請求參數名稱。 例如, |
RequestParam.N.Type | String | 否 | VARCHAR | 請求參數類型,請參見JDBCType。 目前僅支持:
|
RequestParam.N.Desc | String | 否 | 設備狀態 | 請求參數的描述。 |
RequestParam.N.Example | String | 否 | dksiaiek23s | 請求參數值示例。 |
RequestParam.N.Required | Boolean | 否 | true | 該請求參數是否必填。
|
Desc | String | 否 | 數據分析API | API的描述。 |
ResponseParam.N.Name | String | 否 | deviceCount | 返回參數名稱。 |
ResponseParam.N.Type | String | 否 | INTEGER | 返回參數類型,請參見JDBCType。 目前僅支持:
|
ResponseParam.N.Desc | String | 否 | 設備總數 | 返回參數描述。 |
ResponseParam.N.Example | String | 否 | 100 | 返回參數值示例。 |
ResponseParam.N.Required | Boolean | 否 | true | 該返回參數是否必須返回。
說明 返回參數中,此參數無需處理。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例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
以上示例中的信息說明如下:
|
CreateTime | Long | 1557839468865 | API的創建時間,單位為毫秒(ms)。 |
LastUpdateTime | Long | 1557839468865 | API的最后更新時間,單位為毫秒(ms)。 |
ErrorMessage | String | 請求參數錯誤 | 調用失敗時,返回的出錯信息。 |
RequestId | String | 57b144cf-09fc-4916-a272-a62902d5b207 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
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
}
}