全部產品
Search
文件中心

IoT Platform:QueryDeviceOriginalPropertyStatus

更新時間:Feb 14, 2025

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

QPS限制

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

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

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String QueryDeviceOriginalPropertyStatus

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

Asc Integer 0

指定查詢屬性資料的字典排序方式。取值:

  • 0:根據返回參數Identifier的值,按照字典倒序。
  • 1:根據返回參數Identifier的值,按照字典正序。
PageSize Integer 10

指定返回結果中每頁顯示的記錄數。數量限制:每頁最多可顯示50條。

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.common.InvalidPageParams

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

Data Struct

調用成功時,返回的資料,更多資訊,請參見List包含的參數。

List Array of PropertyStatusDataInfo

返回的屬性集合資訊(PropertyStatusInfo)。

PropertyStatusDataInfo
Identifier String Temperture

屬性標識符。

Time Long 1517553572362

屬性修改的時間,單位是毫秒。

Value String 26

屬性值。

NextPageToken String Bo***x44Qx

下一頁標識。

NextValid Boolean true

是否有下一頁屬性記錄。

  • true:有。
  • false:沒有。

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

ErrorMessage String 系統異常

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

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

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

Success Boolean true

表示是否調用成功。

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

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceOriginalPropertyStatus
&Asc=0
&PageSize=10
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceOriginalPropertyStatusResponse>
  <Data>
        <NextValid>false</NextValid>
        <nextPageToken>Bo***x44Qx</nextPageToken>
        <List>
              <PropertyStatusInfo>
                    <Value>48</Value>
                    <Time>1579249151178</Time>
                    <Identifier>Humidity</Identifier>
              </PropertyStatusInfo>
              <PropertyStatusInfo>
                    <Value>32.46</Value>
                    <Time>1579249151178</Time>
                    <Identifier>Temperature</Identifier>
              </PropertyStatusInfo>
        </List>
  </Data>
  <RequestId>84BAD25B-9879-4BA1-9213-F576C6558D77</RequestId>
  <Success>true</Success>
</QueryDeviceOriginalPropertyStatusResponse>

JSON格式

{
	"Data": {
        "NextValid": false, 
        "nextPageToken": "Bo***x44Qx", 
		"List": {
			"PropertyStatusInfo": [
				{
					"Value": "48",
					"Time": "1579249151178",
					"Identifier": "Humidity"
				},
				{
					"Value": "32.46",
					"Time": "1579249151178",
					"Identifier": "Temperature"
				}
			]
		}
	},
	"RequestId": "84BAD25B-9879-4BA1-9213-F576C6558D77",
	"Success": true
}

錯誤碼

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