調(diào)用該接口創(chuàng)建數(shù)據(jù)源流轉(zhuǎn)的數(shù)據(jù)目的。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為10。

說明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 CreateDestination

系統(tǒng)規(guī)定參數(shù)。取值：CreateDestination。
Name String 是 DataPurpose

數(shù)據(jù)目的名稱。
Type String 是 REPUBLISH

數(shù)據(jù)目的操作類型，可取值：

  • REPUBLISH：將解析器腳本處理后的Topic數(shù)據(jù)轉(zhuǎn)發(fā)至物聯(lián)網(wǎng)平臺(tái)的另一個(gè)通信Topic。
  • AMQP：將解析器腳本處理后的Topic數(shù)據(jù)流轉(zhuǎn)到AMQP消費(fèi)組。
  • DATAHUB：將解析器腳本處理后的Topic數(shù)據(jù)轉(zhuǎn)發(fā)至阿里云DataHub，進(jìn)行流式數(shù)據(jù)處理。
  • ONS：將解析器腳本處理后的Topic數(shù)據(jù)轉(zhuǎn)發(fā)至阿里云消息隊(duì)列RocketMQ，進(jìn)行消息分發(fā)。
  • MNS：將解析器腳本處理后的Topic數(shù)據(jù)發(fā)送至阿里云消息服務(wù)中，進(jìn)行消息傳輸。
  • FC：將解析器腳本處理后的Topic數(shù)據(jù)發(fā)送至阿里云函數(shù)計(jì)算服務(wù)，進(jìn)行事件計(jì)算。
  • OTS：將解析器腳本處理后的Topic數(shù)據(jù)發(fā)送至阿里云表格存儲(chǔ)（Tablestore），進(jìn)行NoSQL數(shù)據(jù)存儲(chǔ)。
Configuration String 是 {"topic":"/a1POX0c****/device1/user/get","topicType":1}

數(shù)據(jù)目的對(duì)應(yīng)的配置信息，傳入格式為JSON String。不同規(guī)則動(dòng)作類型所需內(nèi)容不同，具體要求和示例請(qǐng)參見本表格下方的參數(shù)補(bǔ)充說明。
IotInstanceId String 否 iot-2w****

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁面，查看當(dāng)前實(shí)例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無實(shí)例概覽頁面或ID值，則無需傳入。

實(shí)例的更多信息，請(qǐng)參見實(shí)例概述。

Description String 否 數(shù)據(jù)流轉(zhuǎn)至數(shù)據(jù)庫。

數(shù)據(jù)目的描述信息。
REPUBLISH類型Configuration定義

名稱

描述

productKey

轉(zhuǎn)發(fā)至另一個(gè)Topic所屬產(chǎn)品的ProductKey。

REPUBLISH類型Configuration示例： 


{
    "productKey":"hf****3xn"
}
AMQP類型Configuration定義

名稱

描述

groupId

消費(fèi)組ID。

AMQP類型Configuration示例： 


{
    "groupId":"ZTh1JmuZcUfv44p4z00****"
}
OTS類型Configuration定義

名稱

描述

instanceName

表格存儲(chǔ)中用來接收信息的實(shí)例名稱。

regionName

目標(biāo)實(shí)例所在的阿里云地域代碼，例如cn-shanghai。

tableName

表格存儲(chǔ)中用來接收信息的數(shù)據(jù)表名稱。

role

授權(quán)角色信息。通過授予物聯(lián)網(wǎng)平臺(tái)指定的系統(tǒng)服務(wù)角色，您可以授權(quán)物聯(lián)網(wǎng)平臺(tái)訪問您的表格存儲(chǔ)。授權(quán)角色信息：

{"roleName":"AliyunIOTAccessingOTSRole","roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"}

${uid}為您的阿里云賬號(hào)ID。您可以登錄控制臺(tái)，在賬號(hào)安全設(shè)置頁面查看您的賬號(hào)ID。

AliyunIOTAccessingOTSRole是訪問控制中定義的服務(wù)角色。用于授予物聯(lián)網(wǎng)平臺(tái)訪問表格存儲(chǔ)。關(guān)于角色的更多信息，請(qǐng)?jiān)谠L問控制RAM控制臺(tái)的角色管理頁面進(jìn)行角色管理。

OTS類型Configuration示例： 


{
    "instanceName":"${instanceName}",
    "regionName":"cn-shanghai",
    "tableName":"test_table",
    "role":{
        "roleName":"AliyunIOTAccessingOTSRole",
        "roleArn":"acs:ram::${uid}:role/aliyuniotaccessingotsrole"
    }
}
DATAHUB類型Configuration定義

名稱

描述

projectName

目標(biāo)DataHub中用來接收信息的具體Project。

topicName

目標(biāo)DataHub中用來接收信息的具體Topic。

regionName

目標(biāo)DataHub所在的阿里云地域代碼，例如cn-shanghai。

role

授權(quán)角色信息。通過授予IoT指定的系統(tǒng)服務(wù)角色，您可以授權(quán)物聯(lián)網(wǎng)平臺(tái)訪問您的DataHub。授權(quán)角色信息格式：

{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingdatahubrole","roleName": "AliyunIOTAccessingDataHubRole"}

${uid}為您的阿里云賬號(hào)ID。您可以登錄控制臺(tái)，在賬號(hào)安全設(shè)置頁面查看您的賬號(hào)ID。

AliyunIOTAccessingDataHubRole是訪問控制中定義的服務(wù)角色。用于授予物聯(lián)網(wǎng)平臺(tái)訪問DataHub。關(guān)于角色的更多信息，請(qǐng)?jiān)谠L問控制RAM控制臺(tái)的角色管理頁面進(jìn)行角色管理。

DATAHUB類型Configuration示例： 


{
    "role":{
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingdatahubrole",
        "roleName": "AliyunIOTAccessingDataHubRole"
    },
    "ProjectName": "test_project_name",
    "RegionName": "cn-shanghai",
    "TopicName": "test_topic"
}
MNS類型Configuration定義

名稱

描述

themeName

消息服務(wù)中用來接收信息的目標(biāo)主題名稱。

regionName

目標(biāo)消息服務(wù)所在的阿里云地域代碼，例如cn-shanghai。

role

授權(quán)角色信息。通過授予物聯(lián)網(wǎng)平臺(tái)指定的系統(tǒng)服務(wù)角色，您可以授權(quán)物聯(lián)網(wǎng)平臺(tái)訪問您的消息服務(wù)。授權(quán)角色信息：

{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmnsrole","roleName": "AliyunIOTAccessingMNSRole"}

${uid}為您的阿里云賬號(hào)ID。您可以登錄控制臺(tái)，在賬號(hào)安全設(shè)置頁面查看您的賬號(hào)ID。

AliyunIOTAccessingMNSRole是訪問控制中定義的服務(wù)角色。用于授予物聯(lián)網(wǎng)平臺(tái)訪問消息服務(wù)。關(guān)于角色的更多信息，請(qǐng)?jiān)谠L問控制RAM控制臺(tái)的角色管理頁面進(jìn)行角色管理。

MNS類型?Configuration??示例： 


{
    "themeName": "test_name",
    "role":{
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingmnsrole",
        "roleName": "AliyunIOTAccessingMNSRole"
    },
    "regionName": "cn-shanghai"
}
ONS類型Configuration定義
說明 您需通過調(diào)用消息隊(duì)列RocketMQ的SDK，或在消息隊(duì)列RocketMQ控制臺(tái)，授權(quán)物聯(lián)網(wǎng)平臺(tái)訪問消息隊(duì)列RocketMQ（至少要授予物聯(lián)網(wǎng)平臺(tái)發(fā)布權(quán)限），然后才能夠成功創(chuàng)建將Topic數(shù)據(jù)轉(zhuǎn)發(fā)至消息隊(duì)列RocketMQ的規(guī)則動(dòng)作。

名稱

描述

instanceId

RocketMQ中用來接收消息的目標(biāo)Topic所屬的實(shí)例ID。

topic

RocketMQ中用來接收信息的目標(biāo)Topic。

regionName

目標(biāo)RocketMQ實(shí)例所在的阿里云地域代碼，例如cn-shanghai。

目前僅支持同地域內(nèi)數(shù)據(jù)流轉(zhuǎn)。

role

授權(quán)角色信息。通過授予物聯(lián)網(wǎng)平臺(tái)指定的系統(tǒng)服務(wù)角色，您可以授權(quán)物聯(lián)網(wǎng)平臺(tái)訪問您的消息隊(duì)列RocketMQ服務(wù)。授權(quán)角色信息：

{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingmqrole","roleName": "AliyunIOTAccessingMQRole"}

${uid}為您的阿里云賬號(hào)ID。您可以登錄控制臺(tái)，在賬號(hào)安全設(shè)置頁面查看您的賬號(hào)ID。

AliyunIOTAccessingMQRole是訪問控制中定義的服務(wù)角色。用于授予物聯(lián)網(wǎng)平臺(tái)訪問消息隊(duì)列RocketMQ。關(guān)于角色的更多信息，請(qǐng)?jiān)谠L問控制RAM控制臺(tái)的角色管理頁面進(jìn)行角色管理。

ONS類型Configuration示例： 


{
    "instanceId": "${MQ_INST_ID}",
    "role":
    {
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingmqrole",
        "roleName": "AliyunIOTAccessingMQRole"
    },
    "regionName": "cn-shanghai",
    "topic": "test_topic"
}
FC類型Configuration定義

名稱

描述

functionName

函數(shù)服務(wù)中用來接收信息的目標(biāo)函數(shù)名稱。

serviceName

函數(shù)服務(wù)中用來接收信息的目標(biāo)服務(wù)名稱。

regionName

目標(biāo)函數(shù)服務(wù)實(shí)例所在阿里云地域的代碼，如cn-shanghai。

role

授權(quán)角色信息。通過授予物聯(lián)網(wǎng)平臺(tái)指定的系統(tǒng)服務(wù)角色，您可以授權(quán)物聯(lián)網(wǎng)平臺(tái)訪問您的函數(shù)計(jì)算服務(wù)。授權(quán)角色信息：

{"roleArn":"acs:ram::${uid}:role/aliyuniotaccessingfcrole","roleName": "AliyunIOTAccessingFCRole"}

${uid}為您的阿里云賬號(hào)ID。您可以登錄控制臺(tái)，在賬號(hào)安全設(shè)置頁面查看您的賬號(hào)ID。

AliyunIOTAccessingFCRole是訪問控制中定義的服務(wù)角色。用于授予物聯(lián)網(wǎng)平臺(tái)訪問函數(shù)計(jì)算。關(guān)于角色的更多信息，請(qǐng)?jiān)谠L問控制RAM控制臺(tái)的角色管理頁面進(jìn)行角色管理。

FC類型Configuration示例： 


{
    "role":
    {
        "roleArn": "acs:ram::${uid}:role/aliyuniotaccessingfcrole",
        "roleName": "AliyunIOTAccessingFCRole"
    },
    "functionName": "${function_name}",
    "serviceName": "${service_name}",
    "regionName": "cn-shanghai"
}

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說明，請(qǐng)參見公共參數(shù)文檔。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
Code String iot.system.SystemException

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見錯(cuò)誤碼。

Destination Struct

創(chuàng)建成功后，返回的數(shù)據(jù)目的信息。
Configuration String {"topic":"/a1POX0c****/device1/user/get","topicType":1}

數(shù)據(jù)目的對(duì)應(yīng)的配置信息。
DestinationId Long 1003

數(shù)據(jù)目的ID。
IsFailover Boolean false

該數(shù)據(jù)目的配置是否為轉(zhuǎn)發(fā)錯(cuò)誤操作數(shù)據(jù)，即轉(zhuǎn)發(fā)流轉(zhuǎn)到其他云產(chǎn)品失敗且重試失敗的數(shù)據(jù)。

  • true：是轉(zhuǎn)發(fā)錯(cuò)誤操作數(shù)據(jù)。
  • false：不是轉(zhuǎn)發(fā)錯(cuò)誤操作數(shù)據(jù)，而是正常轉(zhuǎn)發(fā)操作。

默認(rèn)值為false。

Name String DataPurpose

數(shù)據(jù)目的名稱。
Type String REPUBLISH

數(shù)據(jù)目的操作類型。
UtcCreated String 2022-03-27T12:45:43.000Z

創(chuàng)建數(shù)據(jù)目的對(duì)應(yīng)的UTC時(shí)間。格式為yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。

ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)，返回的出錯(cuò)信息。
RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。

示例

請(qǐng)求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDestination
&Configuration={"topic":"/a1POX0c****/device1/user/get","topicType":1}
&Name=DataPurpose
&Type=REPUBLISH
&<公共請(qǐng)求參數(shù)>

正常返回示例

XML格式 

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

JSON格式 

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