產品資料API包括產品下裝置的快照資料API、未經處理資料API和事件數目據API，您可以建立指定的產品資料API後，調用對應API擷取產品下指定裝置的未經處理資料、快照資料或事件數目據。本文介紹如何建立和編輯產品資料API。
前提條件
建立產品資料API
產品資料API只能查詢近30天的資料。
在物聯網平台控制台的執行個體概覽頁面，單擊目標企業版執行個體ID或備忘名稱。
在左側導覽列，選擇資料服務 > 資料API。
單擊產品資料API頁簽，然後單擊建立API。
在建立API面板，選中目標產品前的複選框。
單擊應用。
產品資料API列表，會新增對應產品的快照資料和未經處理資料的API。
參數
快照資料API
未經處理資料API
事件數目據API
API名稱
${productName}產品快照資料查詢${productName}產品未經處理資料查詢${productName}產品事件數目據查詢API Path
/${productKey}/snapshot/data/get/${productKey}/rawdata/get/${productKey}/event/data/get其中
${productName}為產品名稱，${productKey}為產品的唯一標識。
編輯產品資料API
對於產品快照資料查詢API和產品未經處理資料查詢API，支援編輯API名稱、入參和出參。
在資料API頁面，單擊產品資料API頁簽。
在API列表，找到目標產品的快照資料查詢API或未經處理資料查詢API，單擊右側操作列的編輯。
在編輯API設定精靈頁面，修改API基本資料，然後單擊下一步。
參數
描述
API名稱
修改API名稱。支援中文、英文字母、數字、底線（_）和短劃線（-）。長度不超過30個字元。
API Path
不支援修改。
API標籤
輸入標籤內容後，按斷行符號鍵，產生標籤。
支援中文、英文字母、數字、底線（_）和短劃線（-）。長度不超過30個字元。
使用標籤功能，為API自訂標識，以便靈活管理API。
重要一個API最多可添加5個標籤。
API描述
輸入API的描述，說明API的功能等資訊。
傳回型別
調用API後，返回資料的格式，固定為JSON。
在配置參數並測試頁面，修改以下配置參數和進階設定。
類別
配置項
說明
配置參數
請求參數
單擊添加參數，選擇可添加的綁定欄位。
添加的參數支援設定作業符、是否必填、樣本值和參數描述。
單擊刪除
表徵圖，刪除對應參數。
重要參數類型為數值型時，操作符不支援
LIKE。返回參數
預設已選擇該API可返回的全部欄位。可設定是否用於排序、樣本值和參數描述。
您可單擊刪除
表徵圖，刪除對應參數。刪除參數後，可單擊添加參數，重新添加綁定欄位為返回參數，也可選中頁面右側的選擇全部參數複選框，重新選擇所有欄位作為API返回參數。說明用於排序是指對查詢擷取的資料根據該欄位的值進行排序（升序或降序），排序後再返回查詢結果。
排序方式
選擇參數的排列順序。
升序（預設）：參數以升序排列。
降序：參數以降序排列。
進階設定
開啟返回結果分頁
選擇是否開啟返回結果分頁。
不開啟：僅可查看100條以內的返回結果。
開啟：可分頁查看所有返回結果。開啟後，自動增加以下公用參數：
pageNum：分頁的頁碼。
pageSize：每頁顯示結果的條數，最大值為100。
逾時報錯設定
調用API的請求超過8000毫秒時，返回逾時報錯。不支援修改該參數。
完成上述配置後，在測試API地區內，輸入請求參數的測試值後，單擊開始測試。
您可在返回樣本頁簽查看返回的樣本資料，也可單擊請求詳情查看發起請求後的具體資訊。
單擊發布。
重要發布API前，需確保該API已通過測試。
僅單擊儲存的API，API詳情頁面顯示狀態為未上線。
API發布成功，才能被正常調用查詢資料。
後續操作
您可以調用產品資料API查看產品下指定裝置的未經處理資料、快照資料和事件數目據。
調用樣本，請參見：
您可以在API詳情頁面，查看API的使用方式。具體操作，請參見查看API。