すべてのプロダクト
Search
ドキュメントセンター

IoT Platform:QueryProductList

最終更新日:Apr 17, 2025

すべてのプロダクトをクエリします。

使用上の注意

QueryProductList 操作の呼び出し時に、CurrentPage に指定した値が PageCount の値よりも大きい場合、ProductInfo は空になります。この場合、Total の戻り値に基づいて CurrentPage と PageSize の新しい値を指定し、QueryProductList 操作を呼び出してプロダクトを再度クエリできます。

たとえば、Total の戻り値が 20 で、PageSize に指定した値が 5 の場合、PageCount の戻り値は 4 になります。結果は、次の式を使用して計算されます。20 / 5 = 4。CurrentPage に 1、2、3、または 4 を指定した場合、ProductInfo は空ではありません。CurrentPage に 4 より大きい値、たとえば 5 を指定した場合、5 ページ目にデータが存在しないため、ProductInfo は空になります。

正常なレスポンスの例:

{
  "RequestId": "62F56B4D-9CBC-518A-8414-CC91BB83FD04",
  "Data": {
    "PageCount": 4,
    "PageSize": 5,
    "CurrentPage": 5,
    "Total": 20,
    "List": {
      "ProductInfo": []
    }
  },
  "Code": "",
  "Success": true
}

QPS 制限

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

    説明

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

  • CurrentPage の値と PageSize の値の積が 100,000 以上の場合、この操作の QPS は減少します。

    この場合、各 Alibaba Cloud アカウントは最大 2 QPS を実行できます。

デバッグ

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

リクエストパラメーター

パラメーター

タイプ

必須

説明

Action

String

はい

QueryProductList

実行する操作。値を QueryProductList に設定します。

CurrentPage

Integer

はい

1

ページ番号。

PageSize

Integer

はい

2

1 ページあたりのエントリ数。有効な値: 1 ~ 200。

IotInstanceId

String

いいえ

iot_instc_pu****_c*-v64********

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

重要
  • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。

  • インスタンスに ID がない場合は、パラメーターを設定する必要はありません。

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

ResourceGroupId

String

いいえ

rg-acfmxazb4ph****

リソースグループ ID。

重要

IoT Platform では、インスタンスのみをリソースグループに追加できます。ResourceGroupId パラメーターは有効ではなくなりました。ResourceGroupId を設定する必要はありません。

AliyunCommodityCode

String

いいえ

iothub_senior

プロダクトのタイプ。有効な値:

  • iothub_senior: プロダクトに Thing Specification Language (TSL) モデルが使用されます。

  • iothub: プロダクトに TSL モデルは使用されません。

説明

このパラメーターを指定しないと、すべてのプロダクトが返されます。

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

レスポンスパラメーター

パラメーター

タイプ

説明

Code

String

iot.system.SystemException

リクエストが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。

Data

Struct

呼び出しが成功した場合に返されるプロダクト情報。詳細については、以下のパラメーターを参照してください。

CurrentPage

Integer

1

ページ番号。

List

ProductInfo の配列

クエリされたプロダクト。

説明

クエリされたプロダクトは、プロダクトが作成された時刻に基づいて、逆時系列順にソートされます。

ProductInfo

AuthType

String

secret

プロダクトのデバイスを IoT Platform に接続するために使用される検証方法。有効な値:

  • secret: デバイスの検証に DeviceSecret が使用されました。

  • id2: デバイスの検証に IoT デバイス ID が使用されました。

  • x509: デバイスの検証に X.509 証明書が使用されました。

DataFormat

Integer

1

デバイスと IoT Platform 間でデータを送信するために通信プロトコルによって使用されるデータ形式。このパラメーターは、AliyunCommodityCode が iothub_senior に設定されている場合にのみ返されます。

有効な値:

  • 0: custom。カスタムシリアルデータ形式が使用されます。この場合、デバイスはバイナリデータストリームなどの生データを送信できます。IoT Platform は、特定のデータ解析スクリプトを使用して、生データを標準の Alink JSON データに変換します。

  • 1: Alink JSON。Alink JSON データは、デバイスと IoT Platform 間で送信されます。Alink は、IoT Platform で事前定義されているデータ交換プロトコルです。

Description

String

これはテストプロダクトです。

プロダクトの説明。

DeviceCount

Integer

128

プロダクト内のデバイスの数。

GmtCreate

Long

1581595942000

プロダクトが作成された時刻。この値は、1970 年 1 月 1 日 00:00:00 Coordinated Universal Time (UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。

NodeType

Integer

0

プロダクトのノードタイプ。このパラメーターは、AliyunCommodityCode が iothub_senior に設定されている場合にのみ返されます。有効な値:

  • 0: デバイス。サブデバイスをデバイスに接続することはできません。デバイスは、IoT Platform に直接接続することも、ゲートウェイのサブデバイスとして IoT Platform に接続することもできます。

  • 1: ゲートウェイ。サブデバイスをゲートウェイに接続できます。ゲートウェイは、サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係を IoT Platform に同期できます。

ProductKey

String

a1T27vz****

プロダクトの ProductKey。ProductKey は、IoT Platform によってプロダクトに発行されるグローバル一意識別子 (GUID) です。

ProductName

String

街灯

プロダクトの名前。

PageCount

Integer

92

返されるページの総数。

PageSize

Integer

2

1 ページあたりのエントリ数。

Total

Integer

184

プロダクトの総数。

ErrorMessage

String

システム例外が発生しました。

呼び出しが失敗した場合に返されるエラーメッセージ。

RequestId

String

4B4ECF2C-6222-42EC-A4B5-C12202E71CEA

リクエストの ID。

Success

Boolean

true

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しは成功しました。

  • false: 呼び出しは失敗しました。

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryProductList
&CurrentPage=1
&PageSize=2
&ResourceGroupId=rg-acfmxazb4ph****
&<共通リクエストパラメーター>

正常なレスポンスの例

XML 形式

<QueryProductListResponse>
  <Data>
        <PageCount>92</PageCount>
        <PageSize>2</PageSize>
        <List>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1A0D4t****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>街灯</ProductName>
                    <DeviceCount>1</DeviceCount>
                    <GmtCreate>1569233025000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
              <ProductInfo>
                    <DataFormat>1</DataFormat>
                    <ProductKey>a1dEvuQ****</ProductKey>
                    <NodeType>0</NodeType>
                    <ProductName>カスタム サブデバイス</ProductName>
                    <DeviceCount>0</DeviceCount>
                    <GmtCreate>1568690432000</GmtCreate>
                    <AuthType>secret</AuthType>
              </ProductInfo>
        </List>
        <CurrentPage>1</CurrentPage>
        <Total>184</Total>
  </Data>
  <RequestId>4B4ECF2C-6222-42EC-A4B5-C12202E71CEA</RequestId>
  <Success>true</Success>
</QueryProductListResponse>

JSON 形式

{
  "Data": {
    "PageCount": 92, 
    "PageSize": 2, 
    "List": {
      "ProductInfo": [
        {
          "DataFormat": 1, 
          "ProductKey": "a1A0D4t****", 
          "NodeType": 0, 
          "ProductName": "街灯", 
          "DeviceCount": 1, 
          "GmtCreate": 1569233025000, 
          "AuthType": "secret"
        }, 
        {
          "DataFormat": 1, 
          "ProductKey": "a1dEvuQ****", 
          "NodeType": 0, 
          "ProductName": "カスタム サブデバイス", 
          "DeviceCount": 0, 
          "GmtCreate": 1568690432000,
          "AuthType": "secret"
        }
      ]
    }, 
    "CurrentPage": 1, 
    "Total": 184
  }, 
  "RequestId": "4B4ECF2C-6222-42EC-A4B5-C12202E71CEA", 
  "Success": true
}

エラーコード

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