Querying Destinations

Function

This API is used to querying destinations.

URI

GET /v2/{project_id}/link/instances/{instance_id}/rules/{rule_id}/destinations

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. Minimum: 0 Maximum: 32
instance_id	Yes	String	Instance ID. Minimum: 0 Maximum: 36
rule_id	Yes	String	Rule ID. Minimum: 0 Maximum: 20

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of items displayed on each page. The maximum value is 999. If the value exceeds 999, only 999 items are returned. Minimum: 0 Maximum: 999999 Default: 10
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0. Minimum: 0 Maximum: 999999 Default: 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Total. Minimum: 0 Maximum: 9999999999999999
size	Integer	Number of records displayed on each page. Minimum: 0 Maximum: 999
items	Array of Destination objects	List of data sources at the destination.

**Table 4** Destination
Parameter	Type	Description
destination_id	Integer	Data source ID at the destination. Minimum: 1 Maximum: 99999999999999999
destination_type	Integer	Destination type. The options are as follows: 0: The destination is MQS in the ROMA instance. 7: The destination is a device. Minimum: 0 Maximum: 10
app_id	String	Application ID. If destination_type is 0, the application ID of the peer end must be specified. Minimum: 0 Maximum: 64
destination_name	String	Data source name at the destination. Minimum: 0 Maximum: 64
topic	String	Topic of the data source at the destination. Minimum: 0 Maximum: 64
server	String	Data source at the destination. Minimum: 0 Maximum: 200
token	String	Token of the data source at the destination. Minimum: 0 Maximum: 1000
tag	String	Tag of the data source at the destination. Minimum: 0 Maximum: 200
mqs_sasl_ssl	Boolean	Whether the SASL field in the MQS data source at the destination needs to support SSL encryption.
user_name	String	Username for accessing the data source at the destination. Minimum: 0 Maximum: 80
password	String	Password for accessing the data source at the destination. Minimum: 0 Maximum: 500

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. Minimum: 0 Maximum: 64
error_msg	String	Error description. Minimum: 0 Maximum: 200
request_id	String	Message ID. Minimum: 0 Maximum: 64

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. Minimum: 0 Maximum: 64
error_msg	String	Error description. Minimum: 0 Maximum: 200
request_id	String	Message ID. Minimum: 0 Maximum: 64

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	System error code, which is the detailed error code of HTTP error codes 4xx and 5xx. Minimum: 0 Maximum: 64
error_msg	String	Error description. Minimum: 0 Maximum: 200
request_id	String	Message ID. Minimum: 0 Maximum: 64

Example Requests

GET /{project_id}/link/instances/{instance_id}/rules/{rule_id}/destinations

Example Responses

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "destination_id" : 27678,
    "destination_type" : 7,
    "app_id" : null,
    "destination_name" : null,
    "topic" : "8si8ST122893/in/214",
    "server" : "server",
    "token" : "token",
    "tag" : "device",
    "mqs_sasl_ssl" : "false",
    "user_name" : null,
    "password" : null
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-ruledest.query]. Parameter is [rule_oid]. Processor is [path].",
  "requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "requestId" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01"
}

Status code: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}