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

タグ別にデバイスをクエリします。

制限

1 回の呼び出しで最大 10 個のタグを指定できます。
各 Alibaba Cloud アカウントは、毎秒最大 5 クエリ（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

デバッグ

Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	QueryDeviceByTags	実行する操作。値を QueryDeviceByTags に設定します。
Tag.N.TagKey	String	Yes	room	デバイスタグのキー。
Tag.N.TagValue	String	Yes	101	デバイスタグの値。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。 IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターを設定する必要があります。このパラメーターを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
CurrentPage	Integer	No	1	返すページ番号。デフォルト値：1。
PageSize	Integer	No	10	各ページに返すエントリの数。最大値：50。デフォルト値：10。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	SimpleDeviceInfo の配列		呼び出しが成功した場合に返されるデバイス情報です。 SimpleDeviceInfo パラメーターには、デバイスの詳細が含まれています。
SimpleDeviceInfo
DeviceName	String	light1	デバイスの DeviceName。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。
ProductKey	String	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
ProductName	String	lamp	プロダクトの名前。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
Page	Integer	1	返されたページのページ番号。
PageCount	Integer	1	ページの総数。
PageSize	Integer	10	各ページに返されるエントリの数。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
Total	Integer	1	レコードの総数。

例

サンプルリクエスト

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByTags
&CurrentPage=1
&PageSize=10
&Tag.1.TagKey=room
&Tag.1.TagValue=101
&Tag.2.TagKey=city
&Tag.2.TagValue=hangzhou
&<Common request parameters>

サンプルの成功レスポンス

XML フォーマット

<QueryDeviceByTags>
  <PageCount>1</PageCount>
  <Data>
        <SimpleDeviceInfo>
              <DeviceName>1102jichu02</DeviceName>
              <ProductKey>a1SM5S1****</ProductKey>
              <IotId>GookTiUcwqRbHosp9Ta10****3a00</IotId>
              <ProductName>TEST</ProductName>
        </SimpleDeviceInfo>
  </Data>
  <PageSize>10</PageSize>
  <Page>1</Page>
  <RequestId>2B5091E4-32D5-4884-A5B2-2E8E713D84AF</RequestId>
  <Success>true</Success>
  <Total>1</Total>
</QueryDeviceByTags>

JSON フォーマット

{
    "PageCount": 1,
    "Data": {
        "SimpleDeviceInfo": [
            {
                "DeviceName": "1102jichu02",
                "ProductKey": "a1SM5S1****",
                "IotId": "GookTiUcwqRbHosp9Ta10****3a00",
                "ProductName": "TEST"
            }
        ]
    },
    "PageSize": 10,
    "Page": 1,
    "RequestId": "2B5091E4-32D5-4884-A5B2-2E8E713D84AF",
    "Success": true,
    "Total": 1
}

エラーコード

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