全部產品
Search
文件中心

IoT Platform:QueryDeviceServiceData

更新時間:Feb 11, 2025

調用介面QueryDeviceServiceData查詢指定裝置的服務調用記錄。

使用說明

  • 標準型和尊享型企業版執行個體:僅可查詢儲存時效內的資料。資料存放區時效,請參見儲存配置
  • 其他執行個體:僅可查詢最近30天內的屬性資料。

QPS限制

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

說明 單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的配額。

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String QueryDeviceServiceData

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

EndTime Long 1579249499000

要查詢的服務調用記錄的結束時間。取值為毫秒值時間戳記,例如:1579249499000。

StartTime Long 1579249499000

要查詢的服務調用記錄的開始時間。取值為毫秒值時間戳記,例如:1579249499000。

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

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

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無ID值,則無需傳入。

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

IotId String Q7uOhVRdZRRlDnTLv****00100

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

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

要查詢的裝置所屬的產品ProductKey

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

要查詢的裝置名稱。

重要 如果傳入該參數,需同時傳入ProductKey
Identifier String Set

要查詢的服務識別符。裝置的服務Identifier。可在控制台中,裝置所屬的產品的功能定義中查看;或調用QueryThingModel

說明 如果是自訂(非預設)模組testFb下服務testService,則參數值為testFb:testService

不傳入此參數時,查詢預設模組下的所有服務資料。

Asc Integer 0

返回結果中,服務調用記錄按時間排序的方式。取值:

  • 0:倒序。
  • 1:正序。
PageSize Integer 10

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

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

返回資料

名稱

類型

樣本值

描述

Code String iot.system.SystemException

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

Data Struct

調用成功時,返回的裝置服務調用記錄。

List Array of ServiceInfo

服務調用記錄集合。每個元素代表一個服務執調用錄。

ServiceInfo
Identifier String Set

服務識別符。

InputData String {\"LightAdjustLevel\":123}

服務的輸入參數,MAP格式的字串,結構為key:value

Name String 設定溫度

服務名稱。

OutputData String {\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}

服務的輸出參數,MAP格式的字串,結構為key:value

Time String 1579249499000

調用服務的時間。

NextTime Long 1579335899000

下一頁面中的服務調用記錄的起始時間。

調用本介面查詢下一頁服務調用記錄時,該值可作為請求StartTime的值。

NextValid Boolean true

是否有下一頁服務調用記錄。

  • true:有。
  • false:沒有。

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

ErrorMessage String 系統異常

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

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

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

Success Boolean true

是否調用成功。

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

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceServiceData
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifier=set
&StartTime=1516538300303
&EndTime=1516541900303
&PageSize=10
&Asc=1
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceServiceDataResponse>
  <Data>
        <NextValid>true</NextValid>
        <NextTime>1517315865197</NextTime>
        <List>
              <ServiceInfo>
                    <Name>set</Name>
                    <Time>1517315865198</Time>
                    <OutputData>{"code":200,"data":{},"id":"100686","message":"success","version":"1.0"}</OutputData>
                    <InputData>{"LightAdjustLevel":123}</InputData>
                    <Identifier>set</Identifier>
              </ServiceInfo>
        </List>
  </Data>
  <RequestId>A44C818E-FA7F-4765-B1E7-01D14AE01C6A</RequestId>
  <Success>true</Success>
</QueryDeviceServiceDataResponse>

JSON格式

{
  "Data": {
    "NextValid": true, 
    "NextTime": 1517315865197, 
    "List": {
      "ServiceInfo": [
        {
          "Name": "set", 
          "Time": 1517315865198, 
          "OutputData": "{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}", 
          "InputData": "{\"LightAdjustLevel\":123}", 
          "Identifier": "set"
        }
      ]
    }
  }, 
  "RequestId": "A44C818E-FA7F-4765-B1E7-01D14AE01C6A", 
  "Success": true
}

錯誤碼

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