QueryDeviceServiceData - IoT Platform - Alibaba Cloud ドキュメントセンター

指定されたデバイスのサービス呼び出しレコードをクエリします。

使用方法

過去 30 日間のサービス呼び出しレコードのみをクエリできます。

説明サービス呼び出しレコードの保存期間は、サービスが呼び出された日から計算されます。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。

説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

OpenAPI Explorer は、署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceServiceData	実行する操作。値を QueryDeviceServiceData に設定します。
EndTime	Long	はい	1579249499000	クエリする時間範囲の終了時刻。値は UNIX タイムスタンプです。単位：ミリ秒。例：1579249499000。
StartTime	Long	はい	1579249499000	クエリする時間範囲の開始時刻。値は UNIX タイムスタンプです。単位：ミリ秒。例：1579249499000。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンスの ID。 IoT Platform コンソールの [概要] ページでインスタンスの ID を確認できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
IotId	String	いいえ	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。この ID は、IoT Platform がデバイスに発行する一意の識別子です。重要 IotId パラメーターは、デバイスの GUID を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせと同じです。このパラメーターに値を指定する場合は、ProductKey パラメーターまたは DeviceName パラメーターを設定する必要はありません。 IotId パラメーター、ProductKey パラメーター、および DeviceName パラメーターに値を指定した場合、IotId パラメーターの値が優先されます。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey です。重要このパラメーターに値を指定する場合は、DeviceName パラメーターを設定する必要があります。
DeviceName	String	いいえ	light	デバイスの DeviceName。重要このパラメーターに値を指定する場合は、ProductKey パラメーターを設定する必要があります。
Identifier	String	いいえ	Set	サービスの識別子。呼び出されるサービスの identifier。サービス識別子は、IoT Platform コンソールの [機能定義] タブで確認できます。また、QueryThingModel 操作を呼び出して、サービス識別子を表示することもできます。説明 testService という名前のサービスが testFb という名前のカスタムモジュールに属している場合、このパラメーターを testFb:testService に設定できます。カスタムモジュールはデフォルトモジュールではありません。このパラメーターに値を指定しない場合、システムはデフォルトモジュールのすべてのサービスデータをクエリします。
Asc	Integer	いいえ	0	返されるサービス呼び出しレコードのソート順。有効な値： 0：逆時系列順 1：時系列順
PageSize	Integer	いいえ	10	各ページに返すエントリの数。有効な値：1 ～ 50。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出す際には、共通リクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるサービス呼び出しレコード。
List	ServiceInfo の配列		サービス呼び出しレコードの配列。各要素はサービス呼び出しレコードを表します。
ServiceInfo
Identifier	String	Set	サービスの識別子。
InputData	String	{\"LightAdjustLevel\":123}	サービスの入力パラメーター。値は MAP 形式の文字列です。構文：`key:value`。
Name	String	Set_Temperature	サービスの名前。
OutputData	String	{\"code\":200,\"data\":{},\"id\":\"100686\",\"message\":\"success\",\"version\":\"1.0\"}	サービスの出力パラメーター。値は MAP 形式の文字列です。構文：`key:value`。
Time	String	1579249499000	サービスが呼び出された時刻。
NextTime	Long	1579335899000	次のページのサービス呼び出しレコードの開始時刻。 QueryDeviceServiceData 操作を呼び出して次のページのサービス呼び出しレコードをクエリする場合は、StartTime パラメーターをこのパラメーターの値に設定する必要があります。
NextValid	Boolean	true	次のページが存在するかどうかを示します。 true false NextValid パラメーターの戻り値が true の場合、次のページの結果をクエリするときに、NextTime パラメーターの値を StartTime パラメーターの値として使用できます。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。この ID は、リクエストを一意に識別します。
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
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。