Help Center> ROMA Connect> API Reference> Out-of-Date APIs> Device Integration APIs (V1)> Rule Engine> Creating a Rule Engine Destination
View PDF

Creating a Rule Engine Destination

Function

This API is used to create the destination of a rule engine on ROMA Connect.

URI

POST /v1/{project_id}/link/instances/{instance_id}/rules/destinations

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

string

Yes

Project ID of each region of a tenant.

instance_id

string

Yes

ID of the ROMA Connect instance used by the tenant.

Request

Request parameters

Table 2 Body parameter description

Parameter

Type

Mandatory

Description

rule_name

string

Yes

Name of a rule that has been created. If the rule does not exist, it will be created by default.

mqs_topic

string

Yes

MQS topic name of the destination.

connect_address

string

Yes

Connection address of the MQS broker.

destination

string

Yes

Type of the destination to which messages are forwarded. Currently, only ROMA_MQS and KAFKA are supported.

mqs_sasl_ssl

Boolean

No

Whether SSL is enabled on the destination MQS.

user_name

string

No

MQS username to be transmitted if SSL is enabled for MQS. If SSL is disabled, this parameter does not need to be transmitted.

password

string

No

MQS password to be transmitted if SSL is enabled for MQS. If SSL is disabled, this parameter does not need to be transmitted.

Example request

https://example.cloud.com/v1/80e2b******f4a398d6409a50932d917/link/instances/fb3b24ab-5d87-473d-9c57-fc6******6a1/rules/destination 
{ 
    "rule_name" : "rule01",
    "mqs_topic" : "mqs-topic01",
    "connect_address" : "192.168.x.x:9093,192.168.0.x:9093,192.168.0.x:9093",
    "destination" : "ROMA_MQS",
    "mqs_sasl_ssl" : false
}

Response

Response parameters

Table 3 Response parameter description

Parameter

Type

Description

destKey

string

Destination of a rule engine.

instanceId

string

Instance ID.

ruleDestOid

integer

Destination ID of a rule engine.

ruleOid

integer

Rule ID.

server

string

Connection address.

sslPassword

string

SSL password.

sslUser

string

SSL username.

topicName

string

Topic name.

Example response

{
    "ruleDestOid": 29,
    "ruleOid": 600071,
    "topicName": "topic02",
    "destKey": "ROMA_MQS",
    "instanceId": "8f3b9416-3f73-44e2-a32d-**********",
    "server": "192.168.0.x:9092,192.x.0.10:9092,192.168.0.x:9092",
    "sslUser": null,
    "sslPassword": "" 
}
Parent topic: Rule Engine