調用GetDataAPIServiceDetail擷取資料服務API詳情-物聯網平台-阿里雲

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	GetDataAPIServiceDetail	系統規定參數。取值：GetDataAPIServiceDetail。
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調用地址的自訂部分。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。

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

返回資料

名稱	類型	樣本值	描述
Code	String	Success	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的資料。
ApiPath	String	/device/getDeviceCountByStatus	API調用地址的自訂部分。
ApiSrn	String	acs:iot::127103983461***:serveapi/device/getDeviceCountByStatus2	API資源標識符，API的全域唯一標識。樣本：`acs:iot::127103983461*:serveapi/device/getDeviceCountByStatus2` 以上樣本中的資訊說明如下： `127103983461**`是阿里雲主帳號ID。 `/device/getDeviceCountByStatus`是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	該請求參數是否必填。 true（預設）：必填。 false：非必填。
Type	String	INTEGER	請求參數類型，目前僅支援： ARRAY VARCHAR INTEGER BIGINT BOOLEAN DECIMAL TIMESTAMP 具體說明，請參見JDBCType。
ResponseParams	Array of ResponseParams		API的返回參數列表。
ResponseParams
Desc	String	裝置數	返回參數描述。
Example	String	100	返回參數值樣本。
Name	String	deviceCount	返回參數名稱。
Required	Boolean	true	該返回參數是否必須返回。 true：必須返回。 false：非必須返回。返回參數中，無需配置該參數。
Type	String	INTEGER	參數類型，目前僅支援： ARRAY VARCHAR INTEGER BIGINT BOOLEAN DECIMAL TIMESTAMP 請參見JDBCType。
TemplateSql	String	SELECT COUNT(*) as deviceCount FROM ${system.device} WHERE status = ${status}	原始SQL的模板化SQL。
Status	Integer	1	API的狀態。 0：可編輯。 1：已測試。 2：發行。
ErrorMessage	String	請求參數錯誤	調用失敗時，返回的出錯資訊。
RequestId	String	57b144cf-09fc-4916-a272-a62902d5b207	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

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"
            }
         ]
      }
   }
}

錯誤碼

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