分散製品をクエリします。
使用方法
この操作は、次の エンドポイント のみを使用して呼び出すことができます： iot.cn-shanghai.aliyuncs.com。
QPS 制限
この API 操作は、アカウントごとに 1 秒あたり最大 5 回呼び出すことができます。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | はい | ListDistributedProduct | 実行する操作。値を ListDistributedProduct に設定します。 |
| CurrentPage | Integer | はい | 1 | 返すページ番号。デフォルト値：1。 |
| PageSize | Integer | はい | 5 | 各ページに返すエントリの数。最大値：200。 |
| SourceInstanceId | String | いいえ | iot-060*** | 製品が属するソースインスタンスの ID。
|
| ProductKey | String | いいえ | a1BwAGV**** | 製品の ProductKey。 |
| TargetInstanceId | String | いいえ | iot-cn-6ja*** | 製品が配布される宛先インスタンスの ID。 インスタンス ID の詳細については、SourceInstanceId パラメーターの説明を参照してください。 |
| TargetUid | String | いいえ | 198*** | 製品が属する Alibaba Cloud アカウントの ID。 IoT Platform コンソールにログインし、プロフィール写真をクリックして、セキュリティ設定 ページで アカウント ID を確認できます。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出す際には、共通のリクエストパラメーターを構成する必要があります。 共通のリクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。 詳細については、「エラーコード」をご参照ください。 |
| Data | Struct | 呼び出しが成功した場合に返される製品。 詳細については、このトピックの「情報」セクションを参照してください。 |
|
| Info | アイテムの配列 | 製品に関する情報。 |
|
| items | |||
| GmtCreate | Long | 1581595942 | 配布タスクが作成された時刻。 |
| 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 アカウントの ID。 デバイスは、同じ Alibaba Cloud アカウント内でのみ、リージョンやインスタンス間で配布できます。 このパラメーターの値は、TargetUid パラメーターの値と同じです。 |
| Total | Integer | 10 | 返された製品の総数。 |
| ErrorMessage | String | システム例外が発生しました。 | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。有効な値：
|
例
リクエストの例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDistributedProduct
&CurrentPage=1
&PageSize=5
&TargetUid=198***
&<共通リクエストパラメーター>成功レスポンスの例
XML 形式
<ListDistributedProductResponse>
<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>
<GmtCreate>1581595942</GmtCreate>
<SourceUid>198***</SourceUid>
<TargetInstanceName>newinstance</TargetInstanceName>
<TargetInstanceId>iot-cn-09k***</TargetInstanceId>
<TargetUid>198***</TargetUid>
<SourceRegion>cn-shanghai</SourceRegion>
<SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
<ProductKey>a1BwAGV****</ProductKey>
</items>
</Info>
</Data>
<Success>true</Success>
</ListDistributedProductResponse>JSON 形式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"Total": 10,
"Info": {
"items": [{
"TargetRegion": "cn-shenzhen",
"SourceInstanceName": "myproInstance",
"TargetAliyunId": "io****@example.com",
"GmtCreate": 1581595942,
"SourceUid": "198***",
"TargetInstanceName": "newinstance",
"TargetInstanceId": "iot-cn-09k***",
"TargetUid": "198***",
"SourceRegion": "cn-shanghai",
"SourceInstanceId": "iot-cn-6ja***",
"ProductKey": "a1BwAGV****"
}]
}
},
"Success": true
}エラーコード
エラーコードの一覧については、「サービスエラーコード」をご参照ください。