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

分散デバイスをクエリします。

使用方法

この操作は、次の エンドポイント を使用してのみ呼び出すことができます： iot.cn-shanghai.aliyuncs.com。
Alibaba Cloud アカウントごとに、最大 5 クエリ/秒（QPS）を実行できます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
複数の Alibaba Cloud アカウントで、同時に最大 200 QPS を実行できます。

デバッグ

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

リクエストパラメータ

パラメータ	タイプ	必須	例	説明
Action	String	はい	ListDistributedDevice	実行する操作。値を ListDistributedDevice に設定します。
CurrentPage	Integer	はい	1	返すページ番号。デフォルト値：1。
PageSize	Integer	はい	5	各ページに返すエントリの数。最大値：200。
ProductKey	String	いいえ	a1BwAGV****	デバイスが属するプロダクトの ProductKey。
DeviceName	String	いいえ	mydevice	デバイスの DeviceName。
TargetUid	String	いいえ	198***	Alibaba Cloud アカウントの ID。IoT Platform コンソールにログインし、プロフィール写真をクリックして、セキュリティ設定ページでアカウント ID を表示できます。
SourceInstanceId	String	いいえ	iot-060***	デバイスが属するソースインスタンスの ID。異なるリージョンのパブリックインスタンスの ID：中国 (上海): iotx-oxssharez200 日本 (東京): iotx-oxssharez300 シンガポール (シンガポール): iotx-oxssharez400 米国 (シリコンバレー): iotx-oxssharez500 米国 (バージニア北部): iotx-oxssharez600 ドイツ (フランクフルト): iotx-oxssharez700 Enterprise Edition インスタンスの ID: 1. IoT Platform コンソールにログインします。上部ナビゲーションバーの左上隅にあるドロップダウンリストからリージョンを選択します。 2. 概要ページで、インスタンス名をクリックします。インスタンスの詳細ページの基本情報セクションでインスタンス ID を確認します。

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

レスポンスパラメータ

パラメータ	タイプ	例	説明
Code	String	iot.system.SystemException	呼び出しが失敗した場合に返されるエラーコード。詳細については、「エラーコード」をご参照ください。
Data	Struct		呼び出しが成功した場合に返されるプロダクト。詳細については、情報を参照してください。
Info	アイテムの配列		デバイスに関する情報。
items
DeviceName	String	mydevice	デバイスの DeviceName。
GmtCreate	Long	1581595942000	配信タスクが作成された時刻。
GmtModified	Long	1581595942222	配信タスクが変更された時刻。
ProductKey	String	a1BwAGV***	デバイスが属するプロダクトの ProductKey。
SourceInstanceId	String	iot-cn-6ja***	ソースインスタンスの ID。
SourceInstanceName	String	myproInstance	ソースインスタンスの名前。
SourceRegion	String	cn-shanghai	デバイスが存在するソースリージョン。
SourceUid	String	198***	デバイスを配信する Alibaba Cloud アカウントの ID。同じ Alibaba Cloud アカウントを使用して、リージョンとインスタンス間でデバイスを配信することのみ可能です。このパラメータの値は、TargetUid パラメータの値と同じです。
TargetAliyunId	String	io****@example.com	デバイスの配信先 Alibaba Cloud アカウント。
TargetInstanceId	String	iot-cn-09k***	宛先インスタンスの ID。
TargetInstanceName	String	newinstance	宛先インスタンスの名前。
TargetRegion	String	cn-shenzhen	デバイスの配信先リージョン。
TargetUid	String	198***	デバイスの配信先 Alibaba Cloud アカウント。同じ Alibaba Cloud アカウントを使用して、リージョンとインスタンス間でデバイスを配信することのみ可能です。このパラメータの値は、TargetUid パラメータの値と同じです。
Total	Integer	10	返されたデバイスの総数。
ErrorMessage	String	システム例外が発生しました。	呼び出しが失敗した場合に返されるエラーメッセージ。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	リクエストの ID。
Success	Boolean	true	呼び出しが成功したかどうかを示します。 true: 呼び出しは成功しました。 false: 呼び出しは失敗しました。

例

リクエストの例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDistributedDevice
&CurrentPage=1
&PageSize=5
&TargetUid=198***
&<共通リクエストパラメータ>

成功レスポンスの例

XML 形式

<ListDistributedDeviceResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Total>10</Total>
        <Info>
              <items>
                    <TargetRegion>cn-shenzhen</TargetRegion>
                    <SourceInstanceName>myproInstance</SourceInstanceName>
                    <TargetAliyunId>io****@example.com</TargetAliyunId>
                    <SourceUid>198***</SourceUid>
                    <GmtModified>1581595942222</GmtModified>
                    <TargetInstanceId>iot-cn-09k***</TargetInstanceId>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <GmtCreate>1581595942000</GmtCreate>
                    <TargetInstanceName>newinstance</TargetInstanceName>
                    <ProductKey>a1BwAGV***</ProductKey>
                    <DeviceName>mydevice</DeviceName>
              </items>
        </Info>
  </Data>
  <Success>true</Success>
</ListDistributedDeviceResponse>

JSON 形式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Total": 10,
        "Info": {
            "items": [{
                "TargetRegion": "cn-shenzhen",
                "SourceInstanceName": "myproInstance",
                "TargetAliyunId": "io****@example.com",
                "SourceUid": "198***",
                "GmtModified": 1581595942222,
                "TargetInstanceId": "iot-cn-09k***",
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "GmtCreate": 1581595942000,
                "TargetInstanceName": "newinstance",
                "ProductKey": "a1BwAGV***",
                "DeviceName": "mydevice"
            }]
        }
    },
    "Success": true
}

エラーコード

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