全部產品
Search
文件中心

IoT Platform:QueryDeviceOriginalPropertyData

更新時間:Feb 14, 2025

調用該介面查詢指定裝置本身上報的原始屬性(通過和未通過物模型校正的所有屬性)記錄。

使用說明

僅可查詢最近30天內的原始屬性資料。

說明 資料存放區時間從屬性時間戳記表示的時間當日開始計算。

QPS限制

單阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為50。

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

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String QueryDeviceOriginalPropertyData

系統規定參數。取值:QueryDeviceOriginalPropertyData。

Asc Integer 0

返回結果中,屬性記錄按時間排序的方式。取值:

  • 0:倒序。
  • 1:正序。
說明 StartTime必須小於EndTime,系統會根據排序方式自動轉換。
EndTime Long 1579249499000

屬性記錄的結束時間。取值為13位毫秒值時間戳記。

Identifier String temperature

屬性的標識符。

  • 對於弱校正,裝置的屬性Identifier,可在控制台中裝置所屬的產品的功能定義中查看;也可以調用QueryThingModel,從返回的物模型資訊中查看。
  • 對於免校正,必須與裝置屬性上報時自訂的identifier一致。
PageSize Integer 10

單個屬性可返回的資料記錄數量。最大值為100。

任意一個屬性返回的資料記錄數量不超過該值。

StartTime Long 1569249488000

要查詢的屬性記錄的開始時間。取值為毫秒值時間戳記。

IotInstanceId String iot_instc_pu****_c*-v64********

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

ProductKey String a1BwAGV****

要查詢裝置所屬的產品ProductKey

重要 如果傳入該參數,需同時傳入DeviceName
DeviceName String light

要查詢的裝置名稱。

重要 如果傳入該參數,需同時傳入ProductKey
NextPageToken String Bo***x44Qx

下一頁標識。如果存在下一頁,服務會返回此token,下次請求帶上即可。

IotId String Q7uOhVRdZRRlDnTLv****00100

要查詢的裝置ID。物聯網平台為該裝置頒發的ID,裝置的唯一識別碼。

重要 IotId作為裝置唯一識別碼,和ProductKeyDeviceName組合是一一對應的關係。如果傳入該參數,則無需傳入ProductKeyDeviceName。如果您同時傳入IotIdProductKeyDeviceName組合,則以IotId為準。

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

返回資料

名稱

類型

樣本值

描述

Code String iot.device.InvalidIoTId

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

Data Struct

調用成功時,返回的裝置屬性記錄。

List Array of PropertyInfo

屬性集合。每個元素代表一個屬性。

PropertyInfo
Time String 1516541885630

屬性修改時間。

Value String {\"data\":32.49}

屬性值。

NextValid Boolean true

是否有下一頁屬性記錄。

  • true:有。
  • false:沒有。

返回NextValidtrue時,可以將NextPageToken的值作為下次查詢的NextPageToken,繼續查詢本次查詢不顯示的資料。

nextPageToken String Bo***x44Qx

下一頁標識。

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

是否調用成功。

  • true:調用成功。
  • false:調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceOriginalPropertyData
&Asc=0
&EndTime=1579249499000
&Identifier=temperature
&PageSize=10
&StartTime=1569249488000
&IotId=Q7uOhVRdZRRlDnTLv****00100
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceOriginalPropertyDataResponse>
  <RequestId>DD8EE383-F007-5647-8B6B-0C52FAC3E7F2</RequestId>
  <Data>
        <NextValid>true</NextValid>
        <nextPageToken>MTcxMjc0N***********</nextPageToken>
        <List>
              <PropertyInfo>
                    <Value>{"data":31.26}</Value>
                    <Time>1712747043556</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":32.43}</Value>
                    <Time>1712747043108</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":30.58}</Value>
                    <Time>1712747042619</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":32.49}</Value>
                    <Time>1712747042182</Time>
              </PropertyInfo>
              <PropertyInfo>
                    <Value>{"data":30.66}</Value>
                    <Time>1712747041731</Time>
              </PropertyInfo>
        </List>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryDeviceOriginalPropertyDataResponse>

JSON格式

{
  "RequestId": "DD8EE383-F007-5647-8B6B-0C52FAC3E7F2",
  "Data": {
    "NextValid": true,
    "nextPageToken": "MTcxMjc0N***********",
    "List": {
      "PropertyInfo": [
        {
          "Value": "{\"data\":31.26}",
          "Time": 1712747043556
        },
        {
          "Value": "{\"data\":32.43}",
          "Time": 1712747043108
        },
        {
          "Value": "{\"data\":30.58}",
          "Time": 1712747042619
        },
        {
          "Value": "{\"data\":32.49}",
          "Time": 1712747042182
        },
        {
          "Value": "{\"data\":30.66}",
          "Time": 1712747041731
        }
      ]
    }
  },
  "Code": "",
  "Success": true
}

錯誤碼

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