Queries distributed products.
Usage notes
- This operation can be called only by using the following endpoint:
iot.cn-shanghai.aliyuncs.com
. -
Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).Note RAM users of an Alibaba Cloud account share the quota of the account.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListDistributedProduct |
The operation that you want to perform. Set the value to ListDistributedProduct. |
CurrentPage | Integer | Yes | 1 |
The number of the page to return. Default value: 1. |
PageSize | Integer | Yes | 5 |
The number of entries to return on each page. Maximum value: 200. |
SourceInstanceId | String | No | iot-060*** |
The ID of the source instance to which the product belongs.
|
ProductKey | String | No | a1BwAGV**** |
The ProductKey of the product. |
TargetInstanceId | String | No | iot-cn-6ja*** |
The ID of the destination instance to which the product is distributed. For more information about instance IDs, see the description of the SourceInstanceId parameter. |
TargetUid | String | No | 198*** |
The ID of the Alibaba Cloud account to which the product belongs. You can log on to the IoT Platform console, click the profile picture, and then view Account ID on the Security Settings page. |
In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | iot.system.SystemException |
The error code returned if the call fails. For more information, see Error codes. |
Data | Struct |
The list of products returned if the call is successful. For more information, see Info. |
|
Info | Array of items |
The information about the product. |
|
items | |||
GmtCreate | Integer | 1581595942 |
The time when the distribution task was created. |
ProductKey | String | a1BwAGV**** |
The ProductKey of the product. |
SourceInstanceId | String | iot-cn-6ja*** |
The ID of the source instance to which the product belongs. |
SourceInstanceName | String | myproInstance |
The name of the source instance to which the product belongs. |
SourceRegion | String | cn-shanghai |
The source region to which the product belongs. |
SourceUid | String | 198*** |
The ID of the Alibaba Cloud account that distributes the product. You can only distribute products across regions and instances by using the same Alibaba cloud account. The value of this parameter is the same as the value of the TargetUid parameter. |
TargetAliyunId | String | io****@example.com |
The Alibaba Cloud account to which the product is distributed. |
TargetInstanceId | String | iot-cn-09k*** |
The ID of the destination instance to which the product is distributed. |
TargetInstanceName | String | newinstance |
The ID of the destination instance to which the product is distributed. |
TargetRegion | String | cn-shenzhen |
The destination region to which the product is distributed. |
TargetUid | String | 198*** |
The ID of the Alibaba Cloud account to which the product is distributed. You can only distribute products across regions and instances by using the same Alibaba cloud account. The value of this parameter is the same as the value of the TargetUid parameter. |
Total | Integer | 10 |
The total number of returned products. |
ErrorMessage | String | A system exception occurred. |
The error message returned if the call fails. |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful.
|
Examples
Sample requests
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDistributedProduct
&CurrentPage=1
&PageSize=5
&TargetUid=198***
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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
}
Error codes
For a list of error codes, visit the API Error Center.