ListDistributedProduct - IoT Platform

使用說明

調用雲端服務的接入地址Endpoint僅支援華東2（上海），即iot.cn-shanghai.aliyuncs.com。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為5。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListDistributedProduct	系統規定參數。取值：ListDistributedProduct。
CurrentPage	Integer	是	1	指定從返回結果中的第幾頁開始顯示。預設值是1。
PageSize	Integer	是	5	每頁顯示的產品數量。最大不超過200條。
SourceInstanceId	String	否	iot-060***	產品所屬的源執行個體ID。各地區公用執行個體ID：華東2（上海）：iotx-oxssharez200。日本：iotx-oxssharez300。新加坡：iotx-oxssharez400。美國（矽谷）：iotx-oxssharez500。美國（維吉尼亞）：iotx-oxssharez600。德國（法蘭克福）：iotx-oxssharez700。查看企業版執行個體ID的步驟： 1. 登入物聯網平台控制台，從頂部導覽列左上方的下拉式功能表選擇地區。 2. 在執行個體概覽頁面，找到目標執行個體，查看ID。
ProductKey	String	否	a1BwAGV****	產品的ProductKey。
TargetInstanceId	String	否	iot-cn-6ja***	產品分發的目標執行個體ID。執行個體ID詳情，請參見參數SourceInstanceId描述。
TargetUid	String	否	198***	產品所屬的阿里雲帳號ID。可登入物聯網平台控制台，單擊帳號頭像，跳轉至基本資料頁面查看帳號ID。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公用請求參數。公用請求參數說明，請參見公用參數文檔。

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Struct		調用成功時，返回的產品列表，詳情請參見Info下資訊。
Info	Array of items		產品的資訊。
items
GmtCreate	Long	1581595942	產品所屬分發任務的建立時間。
ProductKey	String	a1BwAGV****	產品的ProductKey。
SourceInstanceId	String	iot-cn-6ja***	產品的源執行個體ID。
SourceInstanceName	String	myproInstance	產品的源執行個體名稱。
SourceRegion	String	cn-shanghai	產品所屬的源地區。
SourceUid	String	198***	分發產品的源阿里雲帳號ID。目前僅支援同一阿里雲帳號下跨地區和跨執行個體分發產品，此參數與TargetUid值相同。
TargetAliyunId	String	io****@example.com	接收產品的目標阿里雲帳號。
TargetInstanceId	String	iot-cn-09k***	產品分發的目標執行個體ID。
TargetInstanceName	String	newinstance	產品分發的目標執行個體名稱。
TargetRegion	String	cn-shenzhen	產品分發的目標地區。
TargetUid	String	198***	接收產品的目標阿里雲帳號ID。目前僅支援同一阿里雲帳號下跨地區和跨執行個體分發裝置，此參數與SourceUid值相同。
Total	Integer	10	返回的產品總數。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。