调用该接口查询已创建的数据目的列表。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListDestination |
系统规定参数。取值:ListDestination。 |
Page | Integer | 是 | 1 |
指定显示返回结果中的第几页,取值范围为1~100。 |
PageSize | Integer | 是 | 10 |
指定返回结果中每页显示的记录数量,最大值不超过100。 |
IotInstanceId | String | 否 | iot-2w**** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 重要
实例的更多信息,请参见实例概述。 |
SearchName | String | 否 | DataPurpose |
用于检索数据目的名称的字符串。可以传入数据目的名称中任意字符串,根据该字符串可自动检索匹配的数据目的名称。 |
Types.N | RepeatList | 否 | ["REPUBLISH", "OTS"] |
数据目的操作类型列表,可取值:
|
调用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 |
该数据目的配置是否为转发错误操作数据,即转发流转到其他云产品失败且重试失败的数据。
默认值为false。 |
Name | String | DataPurpose |
数据目的名称。 |
Status | String | NORMAL |
数据目的对应的状态。返回值:
|
Type | String | REPUBLISH |
数据目的的操作类型。 |
UtcCreated | String | 2022-03-27T12:45:43.000Z |
创建数据目的对应的UTC时间。格式为 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
Page | Integer | 1 |
显示返回结果中的第几页。 |
PageSize | Integer | 10 |
返回结果中每页显示的记录数量。 |
RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
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
}