すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:BatchQueryDeviceDetail

最終更新日:Apr 17, 2025

プロダクト内の複数のデバイスの詳細をクエリします。

使用方法

  • 1 回の呼び出しで最大 100 台のデバイスをクエリできます。
  • 現在の Alibaba Cloud アカウントにのみ属するデバイスの詳細をクエリできます。 現在のアカウントに属していないデバイスを指定すると、エラーメッセージが返されます。
  • 複数のデバイスを指定し、一部のデバイスが存在しない場合は、既存のデバイスの詳細のみが返されます。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター タイプ 必須 説明
Action String Yes BatchQueryDeviceDetail

実行する操作。 値を BatchQueryDeviceDetail に設定します。

DeviceName.N RepeatList Yes light

デバイスの DeviceName。 最大 100 個の DeviceName を指定できます。

説明 デバイスは同じプロダクトに属している必要があります。
ProductKey String Yes a1BwAGV****

DeviceName.N パラメーターで指定された DeviceName を持つデバイスが属するプロダクトの ProductKey

IotInstanceId String No iot-v64***

インスタンスの ID。IoT Platform コンソール の [概要] ページでインスタンスの ID を確認できます。

重要
  • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。 そうしないと、呼び出しは失敗します。
  • インスタンスに対して 概要 ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。

詳細については、「インスタンスの概要」をご参照ください。

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

レスポンスパラメーター

パラメーター タイプ 説明
Code String iot.system.SystemException

呼び出しが失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。

Data Data の配列

呼び出しが成功した場合に返されるデバイスの詳細。

Data
DeviceName String light

デバイスの DeviceName。

DeviceSecret String mz2Canp4GB7qRVf1OYPNtRqB2anu****

デバイスの DeviceSecret。

FirmwareVersion String V1.0.0.0

デバイスのデフォルトの無線 (OTA) モジュールのバージョン番号。

他の OTA モジュールのバージョン情報をクエリする場合は、ListOTAModuleVersionsByDevice 操作を呼び出します。 バージョン情報はデバイスによって送信されます。

GmtActive String 2019-06-21 20:33:00

デバイスがアクティブ化された時刻。 時刻は GMT 形式です。

GmtCreate String 2019-06-21 20:31:42

デバイスが作成された時刻。 時刻は GMT 形式です。

IotId String Q7uOhVRdZRRlDnTLv****00100

デバイスの ID。 ID は、IoT Platform がデバイスに発行する一意の識別子です。

Nickname String Smart street light

デバイスのエイリアス。

NodeType Integer 0

ノードのタイプ。 有効な値:

  • 0: デバイス。 サブデバイスをデバイスに接続することはできません。 デバイスは、IoT Platform に直接接続するか、ゲートウェイのサブデバイスとして接続できます。
  • 1: ゲートウェイ。 サブデバイスをゲートウェイに接続できます。 ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform に同期できます。
ProductKey String a1BwAGV****

デバイスが属するプロダクトの ProductKey

ProductName String Street light

デバイスが属するプロダクトの名前。

Region String cn-shanghai

デバイスが存在するリージョンの ID。 リージョンは、IoT Platform が存在するリージョンと同じです。 リージョンは、IoT Platform コンソールで確認できます。

Status String ONLINE

デバイスのステータス。 デフォルト値: false。 有効な値:

  • ONLINE: デバイスはオンラインです。
  • OFFLINE: デバイスはオフラインです。
  • UNACTIVE: デバイスはアクティブ化されていません。
  • DISABLE: デバイスは無効になっています。
UtcActive String 2019-06-21T12:31:42.000Z

デバイスがアクティブ化された時刻。 時刻は UTC 形式です。

UtcCreate String 2019-06-21T12:31:42.000Z

デバイスが作成された時刻。 時刻は UTC 形式です。

ErrorMessage String A system exception occurred.

呼び出しが失敗した場合に返されるエラーメッセージ。

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

リクエストの ID。

Success Boolean true

呼び出しが成功したかどうかを示します。

  • true: 呼び出しは成功しました。
  • false: 呼び出しは失敗しました。

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchQueryDeviceDetail
&ProductKey=a1fce6J****
&DeviceName.1=firstDeviceName
&DeviceName.2=secondDeviceName
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<BatchQueryDeviceDetailResponse>
  <Data>
        <Data>
              <DeviceName>Humidity</DeviceName>
              <GmtActive>2020-01-16 13:33:37</GmtActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <DeviceSecret>sLefbFmN9SYfnWLJTePG893XNuRV****</DeviceSecret>
              <GmtCreate>2020-01-08 14:47:08</GmtCreate>
              <UtcCreate>2020-01-08T06:47:08.000Z</UtcCreate>
              <IotId>dwnS41bhNxjslDAIF****00100</IotId>
              <Status>OFFLINE</Status>
              <UtcActive>2020-01-08T06:47:08.000Z</UtcActive>
              <Region>cn-shanghai</Region>
              <NickName>Temperature and humidity</NickName>
              <NodeType>0</NodeType>
              <ProductName>Light, temperature, and humidity sensor</ProductName>
        </Data>
        <Data>
              <Status>OFFLINE</Status>
              <GmtActive>2020-01-17 16:23:15</GmtActive>
              <DeviceName>TH_sensor</DeviceName>
              <Region>cn-shanghai</Region>
              <UtcActive>2020-01-17T03:39:14.000Z</UtcActive>
              <ProductKey>a1ttsqu****</ProductKey>
              <NodeType>0</NodeType>
              <DeviceSecret>dCYdTU3gw5Z77bsHjPk6lPHPVnBT****</DeviceSecret>
              <ProductName>Light, temperature, and humidity sensor</ProductName>
              <GmtCreate>2020-01-17 11:39:14</GmtCreate>
              <UtcCreate>2020-01-17T03:39:14.000Z</UtcCreate>
              <IotId>RKYkCRstfGBh5SZXL****00100</IotId>
        </Data>
  </Data>
  <RequestId>D4C12DD8-4390-4877-B1DC-4049CF4868BC</RequestId>
  <Success>true</Success>
</BatchQueryDeviceDetailResponse>

JSON 形式

{
	"Data": {
		"Data": [
			{
				"DeviceName": "Humidity",
				"GmtActive": "2020-01-16 13:33:37",
				"ProductKey": "a1ttsqu****",
				"DeviceSecret": "sLefbFmN9SYfnWLJTePG893XNuRV****",
				"GmtCreate": "2020-01-08 14:47:08",
				"UtcCreate": "2020-01-08T06:47:08.000Z",
				"IotId": "dwnS41bhNxjslDAIF****00100",
				"Status": "OFFLINE",
				"UtcActive": "2020-01-08T06:47:08.000Z",
				"Region": "cn-shanghai",
				"NickName": "Temperature and humidity",
				"NodeType": 0,
				"ProductName": "Light, temperature, and humidity sensor"
			},
			{
				"Status": "OFFLINE",
				"GmtActive": "2020-01-17 16:23:15",
				"DeviceName": "TH_sensor",
				"Region": "cn-shanghai",
				"UtcActive": "2020-01-17T03:39:14.000Z",
				"ProductKey": "a1ttsqu****",
				"NodeType": 0,
				"DeviceSecret": "dCYdTU3gw5Z77bsHjPk6lPHPVnBT****",
				"ProductName": "Light, temperature, and humidity sensor",
				"GmtCreate": "2020-01-17 11:39:14",
				"UtcCreate": "2020-01-17T03:39:14.000Z",
				"IotId": "RKYkCRstfGBh5SZXL****00100"
			}
		]
	},
	"RequestId": "D4C12DD8-4390-4877-B1DC-4049CF4868BC",
	"Success": true
}

エラーコード

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