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

指定されたデバイスによって送信されたオリジナルのサービスレコードをクエリします。これらのレコードには、指定された Thing Specification Language （TSL）モデルによって検証されたサービスと検証されていないサービスが含まれます。

制限

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

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

各 Alibaba Cloud アカウントは、最大 50 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの Resource Access Management （RAM）ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryDeviceOriginalServiceData	実行する操作。値を QueryDeviceOriginalServiceData に設定します。
Asc	Integer	Yes	0	返されるサービス呼び出しレコードのソート順。有効値： 0: 降順。 1: 昇順。説明開始時刻は終了時刻より前である必要があります。システムは、指定された順序に基づいて返されたレコードをソートします。
EndTime	Long	Yes	1579249499000	クエリする時間範囲の終了。値は 13 桁のタイムスタンプである必要があります。
Identifier	String	Yes	Set	サービスの識別子。低レベルの検証が適用されている場合、次の手順を実行してデバイスイベントの識別子を表示できます。IoT Platform コンソールにログインし、[製品の詳細] ページの [機能の定義] タブに移動します。また、QueryThingModel 操作を呼び出して、返された TSL データでサービス識別子を表示することもできます。検証が適用されていない場合、値はデバイスによって送信されたカスタム識別子の値と同じである必要があります。
PageSize	Integer	Yes	10	各ページに返すエントリの数。最大値：50。
StartTime	Long	Yes	1579249498000	クエリする時間範囲の開始。値は 13 桁のタイムスタンプである必要があります。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。インスタンス ID は、IoT Platform コンソールの概要ページで確認できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
ProductKey	String	No	a1BwAGV****	デバイスが属するプロダクトの ProductKey。説明このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
DeviceName	String	No	light	デバイスの名前。説明このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
NextPageToken	String	No	Bo***x44Qx	次のページの識別子。最初のリクエストへの応答にはこのパラメーターが含まれており、次のリクエストに追加されます。
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。IoT Platform がデバイス用に生成した一意の識別子です。説明このパラメーターを指定する場合は、ProductKey または DeviceName パラメーターを指定する必要はありません。IotId パラメーターはデバイスの一意の識別子を指定し、ProductKey パラメーターと DeviceName パラメーターの組み合わせに対応します。IotId パラメーターと ProductKey パラメーターと DeviceName パラメーターの組み合わせを同時に指定した場合、IotId パラメーターが優先されます。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.device.InvalidIoTId	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるサービス呼び出しレコード。
List	ServiceInfo の配列		サービス呼び出しレコードの配列。各要素はサービス呼び出しレコードを表します。サービスの詳細については、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	サービスが呼び出された時刻。
NextPageToken	String	Bo***x44Qx	次のページの識別子。
NextValid	Boolean	true	次のページが存在するかどうかを示します。 true: 次のページが存在します。 false: 次のページは存在しません。値 trueNextPageToken パラメーターの値を次のリクエストに追加できます。これにより、現在のクエリに含まれていないデータをクエリできます。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryDeviceOriginalServiceData
&Asc=0
&EndTime=1579249499000
&Identifier=Set
&PageSize=10
&StartTime=1579249498000
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<QueryDeviceOriginalServiceDataResponse>
  <Data>
        <NextValid>true</NextValid>
        <NextPageToken>Bo***x44Qx</NextPageToken>
        <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>
</QueryDeviceOriginalServiceDataResponse>

JSON 形式

{
  "Data": {
    "NextValid": true, 
    "NextPageToken": "Bo***x44Qx", 
    "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
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。