全部產品
Search
文件中心

IoT Platform:AttachDestination

更新時間:Feb 17, 2025

調用該介面為解析器關聯指定資料目的。

使用說明

已經建立資料目的(CreateDestination)和解析器(CreateParser)。

QPS限制

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

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

調試

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

請求參數

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

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

DestinationId Long 1002

資料目的ID。您可調用介面ListDestination,查詢資料目的列表,擷取DestinationId

IsFailover Boolean false

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

  • true:是轉寄錯誤操作資料。
  • false:不是轉寄錯誤操作資料,而是正常轉寄操作。

預設值為false

ParserId Long 1000

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

IotInstanceId String iot-2w****

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

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

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

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

返回資料

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

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

ErrorMessage String 系統異常

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

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

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

Success Boolean true

表示是否調用成功。

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

樣本

請求樣本

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

正常返回樣本

XML格式

<AttachDestinationResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Success>true</Success>
</AttachDestinationResponse>

JSON格式

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Success": true
}

錯誤碼

HttpCode 錯誤碼 錯誤資訊 描述
400 iot.system.IllegalRequest The request parameter is invalid. 非法的請求參數。
400 iot.system.SystemException An internal error occurred. Try again later. 系統異常。
400 iot.rule.destinationNotExists Destination not found 流轉目的地不存在

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