Queries the details of a data destination.

QPS limits

Each Alibaba Cloud account can run a maximum of 10 queries per second (QPS).

Note The 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 GetDestination

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

DestinationId Long Yes 1004

The ID of the data destination. You can call the ListDestination operation to query data destinations and obtain the ID of the data destination.

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 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 specify common request parameters when you call this operation. For more information, 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, see Error codes.

Destination Struct

The information about the data destination.

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

The configuration data of the data destination.

DestinationId String 1003

The ID of the data destination.

IsFailover Boolean false

Indicates whether the rule action forwarded error operation data that failed to be forwarded to the destination cloud service. A data forwarding failure indicates that forwarding retries also failed.

  • true: Error operation data is forwarded.
  • false: Normal data instead of error operation data is forwarded.

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 data destination is being initialized.
  • NORMAL: The configuration is completed. The data destination is available.
  • INVALID: The configuration is abnormal. The data destination is unavailable.
  • SHORTCUT: The data forwarding operation is aborted because the data forwarding service is abnormal.
Type String REPUBLISH

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

  • REPUBLISH: forwards topic data that is processed by a parser script to an IoT Platform communication topic.
  • AMQP: forwards topic data that is processed by a parser script to an Advanced Message Queuing Protocol (AMQP) consumer group.
  • DATAHUB: forwards topic data that is processed by a parser script to Alibaba Cloud DataHub for stream computing.
  • ONS: forwards topic data that is processed by a parser script to Message Queue for Apache RocketMQ for message distribution.
  • MNS: forwards topic data that is processed by a parser script to Message Service (MNS) for message transmission.
  • FC: forwards topic data that is processed by a parser script to Function Compute for event computing.
  • OTS: forwards 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'.

ErrorMessage String A system exception occurred.

The error message returned if the call 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=GetDestination
&DestinationId=1004
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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