UpdateDestination - IoT Platform

使用說明

調用介面CreateDestination建立資料目的成功後，若有業務需要，您可根據返回的DestinationId更新對應資料目的資訊。

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	UpdateDestination	系統規定參數。取值：UpdateDestination。
Configuration	String	是	{"topic":"/a1POX0c****/device1/user/get","topicType":1}	資料目的對應的配置資訊，傳入格式為JSON String。不同規則動作類型所需內容不同，具體要求和樣本說明，請參見CreateDestination中Configuration參數描述。
DestinationId	Long	是	1002	資料目的ID。您可調用介面ListDestination，查詢資料來源列表，擷取DestinationId。
Name	String	是	DataPurpose	資料目的名稱。
Type	String	是	REPUBLISH	資料目的操作類型，可取值： 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資料存放區。
IotInstanceId	String	否	iot-2w****	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
Description	String	否	資料流轉至另一個Topic。	資料目的描述資訊。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	表示是否調用成功。 true：調用成功。 false：調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=UpdateDestination
&Configuration={"topic":"/a1POX0c****/device1/user/get","topicType":1}
&DestinationId=1002
&Name=DataPurpose
&Type=REPUBLISH
&<公用請求參數>

正常返回樣本

XML格式

<UpdateDestinationResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</UpdateDestinationResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	iot.system.SystemException	An internal error occurred. Try again later.	系統異常。
400	iot.ruleng.NullRuleActionConfig	The rule action configuration is empty.	規則動作的配置為空白。
400	iot.common.InvalidFormattedParameter	The parameter format is invalid.	參數格式錯誤。

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