すべてのプロダクト
Search

このプロダクト

    IoT Platform:BatchGetDeviceState

    ドキュメントセンター

    IoT Platform:BatchGetDeviceState

    最終更新日:Apr 17, 2025

    複数のデバイスの状態を一度にクエリします。

    説明

    この操作を呼び出すと、次の操作を実行できます。

    • ProductKey パラメーターに値を指定し、DeviceName パラメーターに複数の値を指定して、プロダクトに属するデバイスの状態をクエリできます。
    • IotId パラメーターに複数の値を指定して、異なるプロダクトに属するデバイスの状態をクエリできます。
    重要 1回の呼び出しで最大 50 台のデバイスの状態をクエリできます。

    QPS 制限

    各 Alibaba Cloud アカウントは、毎秒最大 50 クエリ（QPS）を実行できます。

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

    デバッグ

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

    リクエストパラメーター

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

    実行する操作。値を BatchGetDeviceState に設定します。
    DeviceName.N RepeatList No light

    デバイスの名前。

    重要 このパラメーターを設定する場合、ProductKey パラメーターにも値を指定する必要があります。
    IotInstanceId String No iot_instc_pu****_c*-v64********

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

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

    詳細については、「概要」をご参照ください。
    ProductKey String No a1BwAGV****

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

    重要 このパラメーターを設定する場合、DeviceName パラメーターにも値を指定する必要があります。
    IotId.N RepeatList No Q7uOhVRdZRRlDnTLv****00100

    デバイスの ID。

    重要 IotId パラメーターは、デバイスのグローバル一意識別子（GUID）を指定します。 IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせに対応します。このパラメーターを設定する場合、ProductKey パラメーターまたは DeviceName パラメーターを設定する必要はありません。 IotId、ProductKey、および DeviceName パラメーターに値を指定した場合、IotId パラメーターの値が優先されます。

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

    レスポンスパラメーター

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

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

    呼び出しが成功した場合に返されるデバイスステータス情報。詳細については、DeviceStatus パラメーターに含まれる以下のパラメーターを参照してください。
    DeviceStatus
    AsAddress String 192.0.2.1

    デバイスの IP アドレス。
    DeviceId String dwnS41bhNxjslDAI****

    デバイスの ID（期限切れ）。

    説明 このパラメーターはサポートされなくなりました。デバイスの識別にこのパラメーターを使用しないでください。 IotIdProductKeyプロダクトキー
    DeviceName String light

    デバイスの DeviceName。
    IotId String dwnS41bhNxjslDAI****000100

    デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。
    LastOnlineTime String 2020-01-17 16:19:11

    デバイスが最後にオンラインになった時刻。
    Status String OFFLINE

    デバイスの状態。有効な値：

    • ONLINE: デバイスはオンラインです。
    • OFFLINE: デバイスはオフラインです。
    • UNACTIVE: デバイスはアクティブ化されていません。
    • DISABLE: デバイスは無効になっています。
    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=BatchGetDeviceState
&productKey=a1BwAGV****
&DeviceName.1=device1
&DeviceName.2=device2
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <BatchGetDeviceStateResponse>
  <DeviceStatusList>
        <DeviceStatus>
              <Status>OFFLINE</Status>
              <DeviceId>dwnS41bhNxjslDAI****</DeviceId>
              <DeviceName>Humidity</DeviceName>
              <AsAddress>192.0.2.1</AsAddress>
              <LastOnlineTime>2020-01-17 16:19:11</LastOnlineTime>
              <IotId>dwnS41bhNxjslDAI****000100</IotId>
        </DeviceStatus>
  </DeviceStatusList>
  <RequestId>3258D872-EDC5-4039-B564-C27ED7176741</RequestId>
  <Success>true</Success>
</BatchGetDeviceStateResponse>

    JSON 形式

    {
	"DeviceStatusList": {
		"DeviceStatus": [
			{
				"Status": "OFFLINE",
				"DeviceId": "dwnS41bhNxjslDAI****",
				"DeviceName": "Humidity",
				"AsAddress": "192.0.2.1",
				"LastOnlineTime": "2020-01-17 16:19:11",
				"IotId": "dwnS41bhNxjslDAI****000100"
			}
		]
	},
	"RequestId": "3258D872-EDC5-4039-B564-C27ED7176741",
	"Success": true
}

    エラーコード

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