產品數據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。