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

ルールエンジン内のデータソースのトピックをクエリします。

QPS 制限

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

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

デバッグ

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

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	Yes	ListDataSourceItem	実行する操作。値を ListDataSourceItem に設定します。
DataSourceId	Long	Yes	1001	データソースの ID。 ListParserDataSource 操作を呼び出すことで、インスタンスのすべてのデータソースの ID を取得できます。
Page	Integer	Yes	1	返すページ番号。有効な値：1 ～ 100000。
PageSize	Integer	Yes	10	各ページに返すエントリの数。有効な値：1 ～ 100。
IotInstanceId	String	No	iot-0pp1n8t***	インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの [ID] を表示できます。重要インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。インスタンスに対して [概要] ページまたは ID が生成されていない場合は、このパラメーターを設定する必要はありません。詳細については、「概要」をご参照ください。
SearchName	String	No	thing	トピック名から抽出される部分文字列。この操作は、名前に部分文字列が含まれるトピックを返します。

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

レスポンスパラメーター

パラメーター	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
DataSourceItems	dataSourceItem の配列		返されるトピックに関する情報。
dataSourceItem
DataSourceItemId	Long	129322	データソースのトピックの ID。
DeviceName	String	lightDevice	トピックが属するデバイスの名前。説明トピックが、オープンソースの Message Queuing Telemetry Transport ( MQTT )、MQTT ゲートウェイ、または MQTT デバイスで管理されている製品またはデバイスに属している場合、このパラメーターが返されます。
ProductKey	String	aw3****	トピックが属する製品の ProductKey。説明トピックが、オープンソース MQTT 、MQTT ゲートウェイ、または MQTT デバイスで管理されている製品またはデバイスに属している場合、このパラメーターが返されます。
ScopeType	String	PRODUCT	サブスクライブされたトピックの有効範囲。有効な値： PRODUCT: トピックは製品のすべてのデバイスで使用されます。 DEVICE: トピックは製品の特定のデバイスで使用されます。説明トピックが、オープンソース MQTT 、MQTT ゲートウェイ、または MQTT デバイスで管理されている製品またはデバイスに属している場合、このパラメーターが返されます。
Topic	String	/gyh***z/+/thing/event/property/post	データソースのトピックの名前。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
Page	Integer	1	返されたページのページ番号。
PageSize	Integer	10	1 ページあたりに返されるエントリの数。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。
Total	Integer	100	返されたエントリの総数。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDataSourceItem
&DataSourceId=1001
&Page=1
&PageSize=10
&<共通リクエストパラメーター>

成功レスポンスの例

XML 形式

<ListDataSourceItemResponse>
  <DataSourceItems>
        <dataSourceItem>
              <DataSourceItemId>129322</DataSourceItemId>
              <Topic>/gyh***z/+/thing/event/property/post</Topic>
        </dataSourceItem>
  </DataSourceItems>
  <PageSize>1</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>1</Total>
  <Page>1</Page>
  <Success>true</Success>
</ListDataSourceItemResponse>

JSON 形式

{
    "DataSourceItems": {
        "dataSourceItem": [
            {
                "DataSourceItemId": "129322",
                "Topic": "/gyh***z/+/thing/event/property/post"
            }
        ]
    },
    "PageSize": "1",
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": "1",
    "Page": "1",
    "Success": "true"
}

エラーコード

HttpCode	エラーコード	エラーメッセージ	説明
400	iot.system.SystemException	内部エラーが発生しました。後でもう一度お試しください。	システム例外が発生したために返されたエラーメッセージ。
400	iot.common.InvalidPageParams	指定されたページサイズまたはページパラメーターが無効です。	指定されたページサイズまたはページ番号が無効なために返されたエラーメッセージ。
400	Iot.Device.NotExistedDevice	デバイスが存在しません。	指定されたデバイスが存在しないか、アクティブ化されていないために返されたエラーメッセージ。

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