調用該接口獲取數據算法服務API詳情。
QPS限制
單個阿里云賬號調用該接口的每秒請求數(QPS)最大限制為1。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | GetDataAPIServiceDetail | 系統規定參數。取值:GetDataAPIServiceDetail。 |
ApiSrn | String | 是 | acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2 | API資源標識符,API的全局唯一標識。 調用CreateDataAPIService接口成功創建API,返回的ApiSrn值。 格式: 示例: 以上示例中的信息說明如下:
|
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 實例ID。您可在物聯網平臺控制臺的實例概覽頁面,查看當前實例的ID。 重要
實例的更多信息,請參見實例概述。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公共請求參數。公共請求參數說明,請參見 公共參數文檔。
返回數據
名稱 | 類型 | 示例值 | 描述 |
Code | String | Success | 調用失敗時,返回的錯誤碼。更多信息,請參見錯誤碼。 |
Data | Struct | 調用成功時,返回的數據。 |
|
ApiPath | String | /device/getDeviceCountByStatus | API調用地址的自定義部分。 |
ApiSrn | String | acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2 | API資源標識符,API的全局唯一標識。 示例: 以上示例中的信息說明如下:
|
CreateTime | Long | 1557839468865 | API的創建時間,單位為毫秒(ms)。 |
DateFormat | String | JSON | 返回類型行。 |
Description | String | 描述 | API的描述信息。 |
DisplayName | String | 根據狀態獲取設備數 | API名稱。 |
LastUpdateTime | Long | 1557839468865 | API的最后更新時間,單位為毫秒(ms)。 |
RequestMethod | String | GET/POST | 請求方式。 |
RequestProtocol | String | HTTPS | 協議類型。 |
SqlTemplateDTO | Struct | 調用成功時,返回的SQL模板數據。詳情參見SqlTemplateDTO下參數描述。 |
|
OriginSql | String | SELECT COUNT(*) FROM ${system.device} WHERE status = 1 | API對應的原始SQL。 |
RequestParams | Array of RequestParams | 調用API的請求參數列表。 |
|
RequestParams | |||
Desc | String | 設備狀態 | 請求參數描述。 |
Example | String | 0 | 請求參數值示例。 |
Name | String | status | 請求參數名稱。 |
Required | Boolean | true | 該請求參數是否必填。
|
Type | String | INTEGER | 請求參數類型,目前僅支持:
具體說明,請參見JDBCType。 |
ResponseParams | Array of ResponseParams | API的返回參數列表。 |
|
ResponseParams | |||
Desc | String | 設備數 | 返回參數描述。 |
Example | String | 100 | 返回參數值示例。 |
Name | String | deviceCount | 返回參數名稱。 |
Required | Boolean | true | 該返回參數是否必須返回。
返回參數中,無需配置該參數。 |
Type | String | INTEGER | 參數類型,目前僅支持:
請參見JDBCType。 |
TemplateSql | String | SELECT COUNT(*) as deviceCount FROM ${system.device} WHERE status = ${status} | 原始SQL的模板化SQL。 |
Status | Integer | 1 | API的狀態。
|
ErrorMessage | String | 請求參數錯誤 | 調用失敗時,返回的出錯信息。 |
RequestId | String | 57b144cf-09fc-4916-a272-a62902d5b207 | 阿里云為該請求生成的唯一標識符。 |
Success | Boolean | true | 是否調用成功。
|
示例
請求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=GetDataAPIServiceDetail
&ApiSrn=acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2
&<公共請求參數>
正常返回示例
XML
格式
<GetDataAPIServiceDetailResponse>
<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>
<Status>1</Status>
<DisplayName>根據狀態獲取設備數</DisplayName>
<ApiPath>/device/getDeviceCountByStatus</ApiPath>
<Description>描述</Description>
<SqlTemplateDTO>
<OriginSql>SELECT COUNT(*) FROM ${system.device} WHERE status = 1</OriginSql>
<TemplateSql>SELECT COUNT(*) as deviceCount FROM ${system.device} WHERE status = ${status}</TemplateSql>
<RequestParams>
<name>status</name>
<type>INTEGER</type>
<desc>設備狀態</desc>
<example>0</example>
<required>true</required>
</RequestParams>
<ResponseParams>
<name>deviceCount</name>
<type>INTEGER</type>
<desc>設備數</desc>
<example>100</example>
</ResponseParams>
</SqlTemplateDTO>
</Data>
</GetDataAPIServiceDetailResponse>
JSON
格式
{
"RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
"Success":true,
"Data":{
"ApiSrn":"acs:iot:*:127103983461****:serveapi/device/getDeviceCountByStatus2",
"CreateTime":1557839468865,
"LastUpdateTime":1557839468865,
"Status": 1,
"DisplayName":"根據狀態獲取設備數",
"ApiPath":"/device/getDeviceCountByStatus",
"Description":"描述",
"SqlTemplateDTO":{
"OriginSql":"SELECT COUNT(*) FROM ${system.device} WHERE status = 1",
"TemplateSql":"SELECT COUNT(*) as deviceCount FROM ${system.device} WHERE status = ${status}",
"RequestParams":[
{
"name":"status",
"type":"INTEGER",
"desc":"設備狀態",
"example":"0",
"required":true
}
],
"ResponseParams":[
{
"name":"deviceCount",
"type":"INTEGER",
"desc":"設備數",
"example":"100"
}
]
}
}
}