Queries the data destinations that are associated with a parser.

QPS limits

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

Note The RAM users of an Alibaba Cloud account share the quota of the Alibaba Cloud 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 ListParserDestination

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

ParserId Long Yes 1002

The ID of the parser. You can call the ListParser operation to query parsers and obtain the ID of the parser.

IsFailover Boolean No false

Specifies whether to configure the data destination to forward error operation data. The error operation data indicates the data that failed to be forwarded and re-forwarded to other Alibaba Cloud services.

  • true: forwards error operation data.
  • false (default): forwards normal data instead of error operation data.
IotInstanceId String No iot-2w****

The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If no Overview page or ID is generated for your instance, you do not need to configure this parameter.

For more information, see Overview.

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

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

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

Data Array of destinations

The data destinations.

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

The configuration data of the data destination.

DestinationId Long 1003

The ID of the data destination.

IsFailover Boolean false

Indicates whether the data destination is configured to forward error operation data. The error operation data indicates the data that failed to be forwarded and re-forwarded to other Alibaba Cloud services.

  • true: Error operation data is forwarded.
  • false (default): Normal data instead of error operation data is forwarded.
Name String DataPurpose

The name of the data destination.

Type String REPUBLISH

The operation that is performed on the data of the data destination.

  • REPUBLISH: forwards the topic data that is processed by a parser script to an IoT Platform communication topic.
  • AMQP: forwards the topic data that is processed by a parser script to an Advanced Message Queuing Protocol (AMQP) consumer group.
  • DATAHUB: forwards the topic data that is processed by a parser script to Alibaba Cloud DataHub for stream computing.
  • ONS: forwards the topic data that is processed by a parser script to Message Queue for Apache RocketMQ for message distribution.
  • MNS: forwards the topic data that is processed by a parser script to Message Service (MNS) for message transmission.
  • FC: forwards the topic data that is processed by a parser script to Function Compute for event computing.
  • OTS: forwards the topic data that is processed by a parser script to Tablestore (OTS) for NoSQL data storage.
UtcCreated String 2022-03-27T12:45:43.000Z

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

UtcModified String 2022-05-27T12:45:43.000Z

The time when the data destination was updated. 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 request fails.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListParserDestination
&ParserId=1002
&<Common request parameters>

Sample success responses

XML format 

<ListParserDestinationResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <destinations>
              <Type>REPUBLISH</Type>
              <UtcCreated>2022-03-27T12:45:43.000Z</UtcCreated>
              <Configuration>{"topic":"/a1POX0c****/device1/user/get","topicType":1}</Configuration>
              <UtcModified>2022-05-27T12:45:43.000Z</UtcModified>
              <IsFailover>false</IsFailover>
              <DestinationId>1003</DestinationId>
              <Name>DataPurpose</Name>
        </destinations>
  </Data>
  <Success>true</Success>
</ListParserDestinationResponse>

JSON format 

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "destinations": [
            {
                "Type": "REPUBLISH",
                "UtcCreated": "2022-03-27T12:45:43.000Z",
                "Configuration": "{\"topic\":\"/a1POX0c****/device1/user/get\",\"topicType\":1}",
                "UtcModified": "2022-05-27T12:45:43.000Z",
                "IsFailover": false,
                "DestinationId": 1003,
                "Name": "DataPurpose"
            }
        ]
    },
    "Success": true
}