全部產品
Search
文件中心

IoT Platform:ListParserDestination

更新時間:Feb 17, 2025

調用該介面查詢指定解析器關聯的資料目的列表。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為10。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String ListParserDestination

系統規定參數。取值:ListParserDestination。

ParserId Long 1002

解析器ID。您可調用介面ListParser,查詢解析器列表,擷取ParserId

IsFailover Boolean false

待查詢資料目的配置是否為轉寄錯誤操作資料,即轉寄流轉到其他雲產品失敗且重試失敗的資料。

  • true:是轉寄錯誤操作資料。
  • false(預設):不是轉寄錯誤操作資料,而是正常轉寄操作。
IotInstanceId String iot-2w****

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

Data Array of destinations

調用成功時,返回的資料目的列表資料。

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

資料目的對應的配置資訊。

DestinationId Long 1003

資料目的ID。

IsFailover Boolean false

該資料目的配置是否為轉寄錯誤操作資料,即轉寄流轉到其他雲產品失敗且重試失敗的資料。

  • true:是轉寄錯誤操作資料。
  • false(預設):不是轉寄錯誤操作資料,而是正常轉寄操作。
Name String DataPurpose

資料目的名稱。

Type String REPUBLISH

資料目的的操作類型。

  • REPUBLISH:將解析器指令碼處理後的Topic資料轉寄至物聯網平台的另一個通訊Topic。
  • AMQP:將解析器指令碼處理後的Topic資料流轉到AMQP消費組。
  • DATAHUB:將解析器指令碼處理後的Topic資料轉寄至阿里雲DataHub,進行流式資料處理。
  • ONS:將解析器指令碼處理後的Topic資料轉寄至阿里雲訊息佇列RocketMQ,進行訊息分發。
  • MNS:將解析器指令碼處理後的Topic資料發送至阿里雲Message Service中,進行訊息傳輸。
  • FC:將解析器指令碼處理後的Topic資料發送至阿里雲Function Compute服務,進行事件計算。
  • OTS:將解析器指令碼處理後的Topic資料發送至阿里雲Table Store(Tablestore),進行NoSQL資料存放區。
UtcCreated String 2022-03-27T12:45:43.000Z

建立資料目的對應的UTC時間。格式為yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

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

修改資料目的對應的UTC時間。格式為yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

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

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

表示是否調用成功。

  • true:調用成功。
  • false:調用失敗。

樣本

請求樣本

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListParserDestination
&ParserId=1002
&<公用請求參數>

正常返回樣本

XML格式

<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格式

{
    "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
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 iot.system.SystemException An internal error occurred. Try again later. 系統異常。
400 iot.common.InvalidFormattedParameter The parameter format is invalid. 參數格式錯誤。
400 iot.rule.ListDestinationFailed An error occurred while querying destinations 擷取資料目的列表失敗

訪問錯誤中心查看更多錯誤碼。