ListDestination - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	ListDestination	系統規定參數。取值：ListDestination。
Page	Integer	是	1	指定顯示返回結果中的第幾頁，取值範圍為1~100。
PageSize	Integer	是	10	指定返回結果中每頁顯示的記錄數量，最大值不超過100。
IotInstanceId	String	否	iot-2w****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
SearchName	String	否	DataPurpose	用於檢索資料目的名稱的字串。可以傳入資料目的名稱中任一字元串，根據該字串可自動檢索匹配的資料目的名稱。
Types.N	RepeatList	否	["REPUBLISH", "OTS"]	資料目的操作類型列表，可取值： REPUBLISH：將解析器指令碼處理後的Topic資料轉寄至物聯網平台的另一個通訊Topic。 AMQP：將解析器指令碼處理後的Topic資料流轉到AMQP消費組。 DATAHUB：將解析器指令碼處理後的Topic資料轉寄至阿里雲DataHub，進行流式資料處理。 ONS：將解析器指令碼處理後的Topic資料轉寄至阿里雲訊息佇列RocketMQ，進行訊息分發。 MNS：將解析器指令碼處理後的Topic資料發送至阿里雲Message Service中，進行訊息傳輸。 FC：將解析器指令碼處理後的Topic資料發送至阿里雲Function Compute服務，進行事件計算。 OTS：將解析器指令碼處理後的Topic資料發送至阿里雲Table Store（Tablestore），進行NoSQL資料存放區。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Destinations	Array of destinations		返回的資料目的列表資料。
destinations
Configuration	String	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	資料目的對應的配置資訊。
Description	String	資料流轉至資料庫。	資料目的對應的描述資訊。
DestinationId	Long	1003	資料目的ID。
IsFailover	Boolean	false	該資料目的配置是否為轉寄錯誤操作資料，即轉寄流轉到其他雲產品失敗且重試失敗的資料。 true：是轉寄錯誤操作資料。 false：不是轉寄錯誤操作資料，而是正常轉寄操作。預設值為false。
Name	String	DataPurpose	資料目的名稱。
Status	String	NORMAL	資料目的對應的狀態。傳回值： INIT：初始配置中。 NORMAL：配置完成，正常可用。 INVALID：配置存在異常，不可用。 SHORTCUT：雲產品流轉服務發生異常，導致流轉熔斷。
Type	String	REPUBLISH	資料目的的操作類型。
UtcCreated	String	2022-03-27T12:45:43.000Z	建立資料目的對應的UTC時間。格式為`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
Page	Integer	1	顯示返回結果中的第幾頁。
PageSize	Integer	10	返回結果中每頁顯示的記錄數量。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	100	返回結果記錄總數。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDestination
&Page=1
&PageSize=10
&<公用請求參數>

正常返回樣本

XML格式

<ListDestinationResponse>
  <PageSize>10</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>100</Total>
  <Destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>資料流轉至另一個Topic。</Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
              <IsFailover>false</IsFailover>
              <Status>NORMAL</Status>
              <DestinationId>1004</DestinationId>
              <Name>DataPurpose1</Name>
        </destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>資料流轉至另一個Topic。</Description>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device2/user/get","topicType":1}</Configuration>
              <IsFailover>false</IsFailover>
              <Status>NORMAL</Status>
              <DestinationId>1005</DestinationId>
              <Name>DataPurpose2</Name>
        </destinations>
  </Destinations>
  <Page>1</Page>
  <Success>true</Success>
</ListDestinationResponse>

JSON格式

{
    "PageSize": 10,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Destinations": {
        "destinations": [
            {
                "Type": "REPUBLISH",
                "Description": "資料流轉至另一個Topic。",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
                "IsFailover": false,
                "Status": "NORMAL",
                "DestinationId": 1004,
                "Name": "DataPurpose1"
            },{
                "Type": "REPUBLISH",
                "Description": "資料流轉至另一個Topic。",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device2/user/get\",\"topicType\":1}",
                "IsFailover": false,
                "Status": "NORMAL",
                "DestinationId": 1005,
                "Name": "DataPurpose2"
            }
        ]
    },
    "Page": 1,
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	iot.system.SystemException	An internal error occurred. Try again later.	系統異常。
400	iot.system.IllegalRequest	The request parameter is invalid.	非法的請求參數。

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