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

タグでプロダクトをクエリします。

制限

Alibaba Cloud アカウントごとに、最大 500 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
検索には、タグキーまたはタグキーと値のペアを指定できます。
複数のタグを指定する場合、これらのタグ間の論理関係は OR です。

デバッグ

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

リクエストパラメーター

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

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
ProductInfos	ProductInfo の配列		呼び出しが成功した場合に返されるプロダクトの詳細。ProductInfo パラメーターに詳細が含まれています。説明返されるプロダクト情報は、プロダクトが作成された時間を基準にして、作成日時が新しい順にソートされます。
ProductInfo
CreateTime	Long	1545355537000	プロダクトが作成された日時。
Description	String	これはテストプロダクトです。	プロダクトの説明。
NodeType	Integer	0	プロダクトのノードタイプ。有効な値： 0：デバイス。サブデバイスをデバイスに接続することはできません。デバイスは、IoT Platform に直接接続することも、ゲートウェイのサブデバイスとして接続することもできます。 1：ゲートウェイ。サブデバイスをゲートウェイに接続できます。ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform と同期できます。
ProductKey	String	a1BwAGV****	プロダクトの ProductKey。ProductKey は、IoT Platform が新しいプロダクトに発行するグローバル一意識別子（GUID）です。
ProductName	String	街灯	プロダクトの名前。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true：呼び出しは成功しました。 false：呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=ListProductByTags
&CurrentPage=1
&PageSize=10
&ProductTag.1.TagKey=Reen
&ProductTag.1.TagValue=reen
&ProductTag.2.TagKey=Lock
&ProductTag.2.TagValue=1234
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListProductByTagsResponse>
  <RequestId>09AA366E-81EC-4CF0-B49E-61BCD7C95338</RequestId>
  <Success>true</Success>
  <ProductInfos>
        <ProductInfo>
              <ProductKey>a1BwAGV****</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1581595942000</CreateTime>
              <ProductName>Street light</ProductName>
        </ProductInfo>
        <ProductInfo>
              <ProductKey>a1PO***</ProductKey>
              <NodeType>0</NodeType>
              <CreateTime>1580898565000</CreateTime>
              <ProductName>Sensor </ProductName>
        </ProductInfo>
  </ProductInfos>
</ListProductByTagsResponse>

JSON 形式

{
    "RequestId": "09AA366E-81EC-4CF0-B49E-61BCD7C95338",
    "Success": true,
    "ProductInfos": {
        "ProductInfo": [
            {
                "ProductKey": "a1BwAGV****",
                "NodeType": 0,
                "CreateTime": 1581595942000,
                "ProductName": "Street light"
            },
            {
                "ProductKey": "a1PO***",
                "NodeType": 0,
                "CreateTime": 1580898565000,
                "ProductName": "Sensor"
            }
        ]
    }
}

エラーコード

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