Queries data destinations.

QPS limits

Each Alibaba Cloud account can run up to 10 queries per second (QPS).

Note The Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListDestination

The operation that you want to perform. Set the value to ListDestination.

Page Integer Yes 1

The number of the page to return. Valid values: 1 to 100.

PageSize Integer Yes 10

The number of entries to return on each page. Maximum value: 100.

IotInstanceId String No iot-2w****

The ID of the instance. On the Overview page in the IoT Platform console, you can view the ID of the instance.

Important
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If the Overview page or instance ID is not displayed in the IoT Platform console, you do not need to configure this parameter.

For more information about the instance, see Overview.

SearchName String No DataPurpose

The string that is used to query the data destinations. You can specify keywords to match data destination names.

Types.N RepeatList No ["REPUBLISH", "OTS"]

The actions of forwarding data to data destinations. Data is processed by using a parser script before the data is forwarded. Valid values:

  • REPUBLISH: forwards topic data to an IoT Platform communication topic.
  • AMQP: forwards topic data to an Advanced Message Queuing Protocol (AMQP) consumer group.
  • DATAHUB: forwards topic data to Alibaba Cloud DataHub for stream data processing.
  • ONS: forwards topic data to Message Queue for Apache RocketMQ for message distribution.
  • MNS: forwards topic data to Message Service (MNS) for message transmission.
  • FC: forwards topic data to Function Compute for event computing.
  • OTS: forwards topic data to Tablestore (OTS) for NoSQL data storage.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information about the error codes, see Error codes.

Destinations Array of destinations

The data destinations.

destinations
Configuration String {"topic":"/a1POX0c****/device1/user/get","topicType":1}

The configurations of the data destination.

Description String The data is forwarded to a database.

The description of the data destination.

DestinationId Long 1003

The ID of the data destination.

IsFailover Boolean false

Indicates whether the data destination is configured to receive error operation data. The error operation data is the data that failed to be forwarded two consecutive times.

  • true: The data destination is configured to receive error operation data.
  • false: The data destination is configured to receive regular data rather than error operation data.

Default value: false
Name String DataPurpose

The name of the data destination.

Status String NORMAL

The status of the data destination. Valid values:

  • INIT: The configuration is in progress.
  • NORMAL: The configuration is complete, and the data destination is available.
  • INVALID: The configuration is invalid, and the data destination is unavailable.
  • SHORTCUT: An exception occurs and the data forwarding is stopped.
Type String REPUBLISH

The action of forwarding data to the data destination.

UtcCreated String 2022-03-27T12:45:43.000Z

The time at which the data destination was created. The time is displayed in UTC. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

Page Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

The ID of the request. The ID uniquely identifies this request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.
Total Integer 100

The total number of entries returned.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDestination
&Page=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format 

<ListDestinationResponse>
  <PageSize>10</PageSize>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Total>100</Total>
  <Destinations>
        <destinations>
              <Type>REPUBLISH</Type>
              <Description>The data is forwarded to another 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>The data is forwarded to another 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 format 

{
    "PageSize": 10,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Total": 100,
    "Destinations": {
        "destinations": [
            {
                "Type": "REPUBLISH",
                "Description": "The data is forwarded to another 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": "The data is forwarded to another 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
}