调用该接口查询已创建的数据目的列表。

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