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

製品の詳細をクエリします。

制限

Alibaba Cloud アカウントごとに、最大 50 クエリ/秒（QPS）を実行できます。

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

デバッグ

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

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	Yes	QueryProduct	実行する操作。値を QueryProduct に設定します。
ProductKey	String	Yes	a1BwAGV****	クエリする製品の ProductKey。 ProductKey は、IoT Platform が製品に発行する GUID です。 IoT Platform コンソールを使用するか、QueryProductList 操作を呼び出して、現在のアカウント内のすべての製品に関する情報を表示できます。
IotInstanceId	String	No	iot_instc_pu***_c-v64********	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を確認できます。重要インスタンスに ID がある場合は、このパラメータを設定する必要があります。このパラメータを設定しないと、呼び出しは失敗します。インスタンスに概要ページまたは ID がない場合は、このパラメータを設定する必要はありません。詳細については、「概要」をご参照ください。

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

レスポンスパラメータ

パラメータ	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返される製品情報。
AliyunCommodityCode	String	iothub_senior	製品のタイプ。このパラメータは、Thing Specification Language（TSL）モデルが使用されたかどうかを示します。有効な値： iothub_senior: TSL モデルが使用されました。 iothub: TSL モデルは使用されませんでした。
AuthType	String	secret	製品のデバイスを IoT Platform に接続するために使用された認証方式。有効な値： secret: デバイスの認証に DeviceSecret が使用されました。 id2: デバイスの認証に IoT Internet Device ID が使用されました。 x509: デバイスの認証に X.509 証明書が使用されました。
CategoryKey	String	Lighting	製品が属するカテゴリの識別子。このパラメータは、製品が IoT Platform によって事前に定義された標準カテゴリの TSL モデルを使用している場合に返されます。このパラメータは、AliyunCommodityCode パラメータが iothub_senior に設定されている場合に利用可能です。
CategoryName	String	Street Lamp	製品カテゴリの名前。このパラメータは、製品が IoT Platform によって事前に定義された標準カテゴリの TSL モデルを使用している場合に返されます。このパラメータは、AliyunCommodityCode パラメータが iothub_senior に設定されている場合に利用可能です。
DataFormat	Integer	1	デバイスと IoT Platform 間でデータを送信するために通信プロトコルによって使用されたデータ形式。このパラメータは、AliyunCommodityCode パラメータが iothub_senior に設定されている場合に利用可能です。有効な値： 0: カスタム。カスタムシリアルデータ形式が使用されました。この場合、デバイスはバイナリデータストリームなどの生データを送信できます。 IoT Platform は、指定されたデータ解析スクリプトを使用して、生データを標準の Alink JSON データに変換します。 1: Alink JSON。 Alink JSON データは、デバイスと IoT Platform 間で送信されます。 Alink は、IoT Platform によって事前に定義されたデータ交換プロトコルです。
Description	String	Smart street light	製品の説明。
DeviceCount	Integer	0	製品に属するデバイスの数。
GmtCreate	Long	1581595942000	製品が作成された時刻。値はミリ秒単位のタイムスタンプです。
Id2	Boolean	false	IoT Internet Device ID が有効になっているかどうかを示します。有効な値： true: IoT Internet Device ID が有効になっています。 false: IoT Internet Device ID が無効になっています。
NetType	Integer	3	ネットワーク接続方法。有効な値： 3: Wi-Fi。 6: セルラーネットワーク（2G/3G/4G/5G）。 7: イーサネット。 8: その他。
NodeType	Integer	0	製品のノードタイプ。このパラメータは、AliyunCommodityCode パラメータが iothub_senior に設定されている場合に利用可能です。有効な値： 0: デバイス。サブデバイスをデバイスに接続することはできません。デバイスは、IoT Platform に直接、またはゲートウェイのサブデバイスとして接続できます。 1: ゲートウェイ。サブデバイスをゲートウェイに接続できます。ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform と同期できます。
Owner	Boolean	true	操作が製品の所有者によって呼び出されたかどうかを示します。 true: はい。 false: いいえ。
ProductKey	String	a1T27vz****	製品の ProductKey。製品を作成すると、ProductKey は IoT Platform が製品に発行するグローバル一意識別子（GUID）です。
ProductName	String	Street light	製品の名前。
ProductSecret	String	U5tW7i44uilc****	製品の ProductSecret。
ProductStatus	String	DEVELOPMENT_STATUS	製品のステータス。 DEVELOPMENT_STATUS: 製品は開発中です。 RELEASE_STATUS: 製品は公開されました。
ProtocolType	String	modbus	サブデバイスがゲートウェイに接続するために使用したプロトコルのタイプ。このパラメータは、AliyunCommodityCode パラメータが iothub_senior に設定され、NodeType パラメータが 1 に設定されている場合に利用可能です。有効な値： modbus: Modbus。 opc-ua: OPC UA。 customize: カスタムプロトコル。 ble: BLE。 zigbee: ZigBee。
ValidateType	Integer	1	データ検証のレベル。有効な値： 2: 検証なし。 IoT Platform はデータを検証しません。すべてのデータが転送されます。 IoT Platform コンソールでは、[デバイスの詳細] ページの [TSL データ] タブにデータは表示されません。 1: 低レベル検証。 IoT Platform は、データの identifier フィールドと dataType フィールドのみを検証します。すべてのデータが転送されます。 0: 高レベル検証。 IoT Platform はデータのすべてのフィールドを検証します。検証に合格したデータのみが転送されます。 2020 年 10 月 14 日より前に作成された製品は、高レベル検証のみをサポートしています。 2020 年 10 月 14 日以降に作成された製品は、低レベル検証または検証なしをサポートしています。検証後、検証に合格したデータまたは失敗したデータを表示できます。 IoT Platform コンソールでは、TSL データデバイスの詳細ページのタブにデータが表示されます。検証に失敗したデータは表示されません。転送されたデータの checkFailedData パラメータで、検証に失敗したデータを表示できます。詳細については、「データ形式」をご参照ください。
ErrorMessage	String	A system exception occurred.	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E4F94B97-1D64-4080-BFD2-67461667AA43	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProduct
&ProductKey=a1BwAGV****
&<Common request parameters>

成功レスポンスの例

XML 形式

<QueryProductResponse>
  <Data>
        <Owner>true</Owner>
        <CategoryName>Street lighting</CategoryName>
        <DataFormat>1</DataFormat>
        <ProductKey>a1BwAGV****</ProductKey>
        <ProductStatus>DEVELOPMENT_STATUS</ProductStatus>
        <GmtCreate>1581595942000</GmtCreate>
        <ProductSecret>U5tW7i44uilc****</ProductSecret>
        <NodeType>0</NodeType>
        <ProductName>Street light</ProductName>
        <ValidateType>1</ValidateType>
        <DeviceCount>0</DeviceCount>
        <NetType>3</NetType>
        <AuthType>secret</AuthType>
        <CategoryKey>Lighting</CategoryKey>
        <Id2>false</Id2>
        <AliyunCommodityCode>iothub_senior</AliyunCommodityCode>
  </Data>
  <RequestId>DA5A3C45-D457-48ED-9A20-AEDEA8503401</RequestId>
  <Success>true</Success>
</QueryProductResponse>

JSON 形式

{
    "Data": {
        "Owner": true,
        "CategoryName": "Street lighting",
        "DataFormat": 1,
        "ProductKey": "a1BwAGV****",
        "ProductStatus": "DEVELOPMENT_STATUS",
        "GmtCreate": 1581595942000,
        "ProductSecret": "U5tW7i44uilc****",
        "NodeType": 0,
        "ProductName": "Street light",
        "ValidateType":1,
        "DeviceCount": 0,
        "NetType": 3,
        "AuthType": "secret",
        "CategoryKey": "Lighting",
        "Id2": false,
        "AliyunCommodityCode": "iothub_senior"
    },
    "RequestId": "DA5A3C45-D457-48ED-9A20-AEDEA8503401",
    "Success": true
}

エラーコード

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