调用该接口更新数据目的名称、操作类型和描述信息。

使用说明

调用接口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数据发送至阿里云消息服务中，进行消息传输。
  • FC：将解析器脚本处理后的Topic数据发送至阿里云函数计算服务，进行事件计算。
  • OTS：将解析器脚本处理后的Topic数据发送至阿里云表格存储（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
}