除了使用預置指標API和產品數據API外，您還可以根據業務需要，新建自定義服務API獲取數據指標和自定義存儲表的數據。本文介紹如何創建自定義服務API。
前提條件
操作步驟
在物聯網平臺控制臺的實例概覽頁面，單擊目標企業版實例ID或備注名稱。
在左側導航欄，選擇數據服務 > 數據API。
在數據API頁面，單擊自定義服務API頁簽，然后單擊新建API。
在新建API配置向導頁面，完成API基本信息的配置，然后單擊下一步。
參數
描述
API名稱
輸入API名稱。支持中文、英文字母、數字、下劃線（_）和短劃線（-）。長度不超過30個字符。
API Path
輸入API路徑。作為API資源標識符，實例下具有唯一性。
調用API時，請求參數中apiPath的值與之對應。
以正斜線（/）開頭，支持英文字母、數字、下劃線（_）、正斜線（/），長度不超過128個字符。例如：
pk/temperatureMax。重要API發布后，API Path不支持修改。
API標簽
輸入標簽內容后，按回車鍵，生成標簽。
支持中文、英文字母、數字、下劃線（_）和短劃線（-）。長度不超過30個字符。
使用標簽功能，為API自定義標識，以便靈活管理API。
重要一個API最多可添加5個標簽。
API描述
輸入API的描述，說明API的功能等信息。
返回類型
調用API后，返回數據的格式，固定為JSON。
在配置參數并測試頁面，完成以下配置。
類別
配置項
說明
數據來源
指標
選擇具體指標域和數據集。
數據集是指標域的具體對象組織，例如產品域下具體產品，設備域下具體設備。
指標詳細信息，請參見什么是指標。
存儲表
選擇通過數據解析或SQL分析任務，輸出的自定義存儲表。
更多信息，請參見冷數據存儲表。
配置參數
數據集
僅數據來源選擇指標，并選擇具體指標域和數據集后，自動顯示所選的數據來源。
單擊預覽數據，可跳轉至該數據來源的詳情頁面。
數據范圍
僅數據來源選擇指標，展示該配置項。
選擇API的數據范圍：
衍生指標：基于原始指標、原始定義、衍生定義，經過求和、計算平均數等匯總計算方式得到的數據。
衍生定義：以原始定義為基礎，并應用到子實體上的原始定義指標的衍生。
衍生指標和定義說明，請參見指標類型。
請求參數
單擊添加參數，將所選數據來源的指標，添加到API的請求參數。僅支持系統字段及自定義存儲表的主鍵字段。
添加的參數需包括綁定字段、參數名、參數類型、操作符、必選、示例值、參數描述。
重要參數類型為數值型時，操作符不支持
LIKE。返回參數
單擊添加參數，將所選數據來源的指標，添加到API的返回參數。
添加的參數需包括優先級、綁定字段、參數名、參數類型、用于排序、示例值、參數描述。
選中頁面右側的選擇全部參數復選框，API的返回參數會包括所有已定義的表字段。
說明用于排序是指對查詢獲取的數據根據該字段的值進行排序（升序或降序），排序后再返回查詢結果。
在返回參數里，一個指標僅能被配置成一個參數。
排序方式
選擇參數的排列順序。
升序（默認）：參數以升序排列。
降序：參數以降序排列。
高級設置
開啟返回結果分頁
選擇是否開啟返回結果分頁。
不開啟：僅可查看100條以內的返回結果。
開啟：可分頁查看所有返回結果。開啟后，自動增加以下公共參數：
pageNum：分頁的頁碼。
pageSize：每頁顯示結果的條數，最大值為100。
超時報錯設置
調用API的請求超過8000毫秒時，返回超時報錯。不支持修改該參數。
完成上述配置后，在測試API區域內，輸入請求參數的測試值后，單擊開始測試。
您可在返回示例頁簽查看返回的示例數據，也可單擊請求詳情查看發起請求后的具體信息。
單擊發布。
重要發布API前，需確保該API已通過測試。
僅單擊保存的API，顯示狀態為未上線。
未完成配置的API，可單擊對應的編輯，完成配置后發布上線。
僅可刪除未上線和已下線的API。
在發布成功頁面，單擊再次新建，可創建多個自定義API；單擊去列表查看，可查看已創建的API。
后續操作
已創建的自定義服務API可以調用來獲取數據。具體操作，請參見管理與使用。
調用示例，請參見：