QueryDeviceByStatus の呼び出しによるステータス별 장치 查询 - IoT Platform (IoT)

状態別にデバイスをクエリします。

使用方法

デバイスの状態が変更された後、新しい状態は 10 秒以内に有効になります。新しい状態が有効になったら、新しい状態を使用してデバイスを検索できます。新しい状態が有効になる前は、以前の状態を使用してデバイスを検索できます。

QPS 制限

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

説明

Alibaba Cloud アカウントの Resource Access Management (RAM) ユーザーは、アカウントのクォータを共有します。

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	QueryDeviceByStatus	実行する操作。値を QueryDeviceByStatus に設定します。
Status	Integer	はい	1	デバイスの状態。有効な値： 0: デバイスは非アクティブです。 1: デバイスはオンラインです。 3: デバイスはオフラインです。 8: デバイスは無効になっています。
IotInstanceId	String	いいえ	iot_instc_pu***_c-v64********	インスタンス ID。インスタンス ID は、IoT Platform コンソールの概要タブで確認できます。重要インスタンスに ID がある場合は、このパラメーターを指定する必要があります。このパラメーターを指定しないと、リクエストは失敗します。 IoT Platform コンソールに概要タブまたはインスタンス ID が表示されない場合は、このパラメーターを指定する必要はありません。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
CurrentPage	Integer	いいえ	1	ページ番号。
PageSize	Integer	いいえ	10	1 ページあたりのエントリ数。有効な値：1 ～ 50。
ResourceGroupId	String	いいえ	rg-acfm4l5tcwd***	リソースグループ ID。重要 IoT Platform は、インスタンスごとのみリソースグループ管理をサポートしています。 ResourceGroupId パラメーターは無効です。このパラメーターを指定する必要はありません。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	SimpleDeviceInfo の配列		リクエストが成功した場合に返されるデバイス情報。SimpleDeviceInfo パラメーターには、デバイスの詳細が含まれています。
SimpleDeviceInfo
DeviceName	String	light	デバイスの名前。
DeviceSecret	String	sLefbFmN9SYfnWLJTePG893XNuRV****	デバイスのシークレット。
GmtCreate	String	2021-02-18 10:46:32	デバイスが作成された日時。時間は GMT で表示されます。
GmtModified	String	2021-02-18 10:46:32	デバイス情報が最後に変更された日時。時間は GMT で表示されます。
IotId	String	Av8NGHGtwPrH9BYGLMBi00****	デバイスの ID。
Nickname	String	SensorInShanghai	デバイスのエイリアス。
ProductKey	String	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
Status	String	ONLINE	デバイスの状態。有効な値： UNACTIVE: デバイスは非アクティブです。 ONLINE: デバイスはオンラインです。 OFFLINE: デバイスはオフラインです。 DISABLE: デバイスは無効になっています。
UtcCreate	String	2021-02-18T02:46:32.000Z	デバイスが作成された日時。時間は UTC で表示されます。
UtcModified	String	2021-02-18T02:46:32.000Z	デバイス情報が最後に変更された日時。時間は UTC で表示されます。
ErrorMessage	String	A system exception occurred.	リクエストが失敗した場合に返されるエラーメッセージ。
Page	Integer	1	ページ番号。
PageCount	Integer	1	ページの総数。
PageSize	Integer	10	1 ページあたりのエントリ数。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエスト ID。
Success	Boolean	true	リクエストが成功したかどうかを示します。有効な値： true false
Total	Integer	2	返されたデバイスの総数。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByStatus
&ProductKey=aldafD****
&Status=0
&PageSize=10
&CurrentPage=1
&<Common request parameters>

成功レスポンスの例

XML 形式

<QueryDeviceByStatusResponse>
      <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
      <Success>true</Success>
      <CurrentPage>1</CurrentPage>
      <PageSize>10</PageSize>
      <TotalPageCount>1</TotalPageCount>
      <TotalCount>2</TotalCount>
      <Data>
            <SimpleDeviceInfo>
                  <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
                  <DeviceName>Av8NGHG***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
                  <UtcModified>2021-02-18T02:46:32.000Z</UtcModified>
                  <GmtCreate>2021-02-18 10:46:32</GmtCreate>
                  <UtcCreate>2021-02-18T02:46:32.000Z</UtcCreate>
                  <GmtModified>2021-02-18 10:46:32</GmtModified>
                  <Status>UNACTIVE</Status>
                  <Nickname>SensorInShanghai</Nickname>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
                  <DeviceName>zNIcSmWQ***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
                  <UtcModified>2021-02-09T09:44:55.000Z</UtcModified>
                  <GmtCreate>2021-02-09 17:44:55</GmtCreate>
                  <UtcCreate>2021-02-09T09:44:55.000Z</UtcCreate>
                  <GmtModified>2021-02-09 17:44:55</GmtModified>
                  <DeviceStatus>UNACTIVE</DeviceStatus>
                  <Nickname>DriverInShanghai</Nickname>
            </SimpleDeviceInfo>
      </Data>
</QueryDeviceByStatusResponse>

JSON 形式

{
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true,  
  "CurrentPage": 1, 
  "PageSize": 10, 
  "TotalPageCount": 1,
  "TotalCount": 2,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceName": "Av8NGHG***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2021-02-18T02:46:32.000Z", 
        "GmtCreate": "2021-02-18 10:46:32", 
        "UtcCreate": "2021-02-18T02:46:32.000Z", 
        "GmtModified": "2021-02-18 10:46:32", 
        "Status": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceName": "zNIcSmWQ***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2021-02-09T09:44:55.000Z", 
        "GmtCreate": "2021-02-09 17:44:55", 
        "UtcCreate": "2021-02-09T09:44:55.000Z", 
        "GmtModified": "2021-02-09 17:44:55", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }  
}

エラーコード

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