Querying Rules

Function

Querying Rules

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. The default value is default for compatibility with 20.0.Project ID. For details about how to get the project ID, see "Appendix" > "Obtaining a Project ID" in this document.
instance_id	Yes	String	Instance ID. The default value is default for compatibility with 20.0.

**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.
app_id	No	String	Application ID.
name	No	String	Rule name.
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
created_by	No	String	Creator.
created_date_start	No	Long	Creation start time. Format: timestamp (ms), in UTC.
created_date_end	No	Long	Creation end time. Format: timestamp (ms), in UTC.
dest_type	No	Integer	Operation type. Options: 0: The destination is an MQS data source in the same ROMA Connect instance; 2: The destination is an MRS Kafka data source in the same ROMA Connect instance; 3: The destination is a Kafka data source in the same ROMA Connect instance; 6: The destination is a DIS data source; 7: The destination is a device; 8: The destination is a rule plug-in.
dest_topic	No	String	Destination topic.
src_type	No	String	Source type. Options: product: Queries product-level source topics. device: Queries device-level source topics and superordinate product-level source topics. device_only: Queries device-level source topics. If both this parameter and application ID are not specified, all sources are queried. If only application ID is specified, sources of the application are queried.
product_id	No	Integer	This parameter is valid if src_type is set to product, device, or device_only.
product_name	No	String	This parameter is valid if src_type is set to product.
device_name	No	String	This parameter is valid if src_type is set to device or device_only.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total.
size	Integer	Number of records displayed on each page.
items	Array of Rule objects	Rule list.

**Table 5** Rule
Parameter	Type	Description
permissions	Array of strings	Permission.
rule_id	Integer	Rule ID.
name	String	Rule name, which is a string of 1 to 64 characters containing case-sensitive letters, digits, underscores (_), and hyphens (-).
app_id	String	Application ID.
app_name	String	Application name.
description	String	Description.
status	Integer	Rule status. The options are as follows: 0: enabled; 1: disabled.
data_parsing_status	Integer	Data parsing status. If status is set to 0, this parameter is mandatory and must be set to 0 (indicating that data parsing is enabled) or 1 (indicating that data parsing is disabled).
sql_field	String	SQL query field.
sql_where	String	SQL query condition.
rule_express	String	Complete rule expression.
created_user	CreatedUser object	Name of the user who created the attribute.
last_updated_user	LastUpdatedUser object	User who performed the last update.
created_datetime	Long	Creation start time. The format is timestamp(ms) and the UTC time zone is used.
last_updated_datetime	Long	Last modification time (timestamp, in milliseconds). The UTC time zone is used.

**Table 6** CreatedUser
Parameter	Type	Description
user_id	String	User ID (reserved).
user_name	String	Username.

**Table 7** LastUpdatedUser
Parameter	Type	Description
user_id	String	User ID (reserved).
user_name	String	Username.

Status code: 400

**Table 8** 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.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 404

**Table 9** 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.
error_msg	String	Error description.
request_id	String	Message ID.

Status code: 500

**Table 10** 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.
error_msg	String	Error description.
request_id	String	Message ID.

Example Requests

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

Example Responses

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "permissions" : [ "read", "access", "delete", "modify" ],
    "rule_id" : 702244,
    "name" : "rule",
    "app_id" : "a1503e51-46f7-4d23-8617-7cb2d28dde98",
    "app_name" : "app-link",
    "description" : null,
    "status" : 0,
    "data_parsing_status" : 1,
    "sql_field" : null,
    "sql_where" : null,
    "rule_express" : null,
    "created_user" : {
      "user_id" : "",
      "user_name" : "user"
    },
    "last_updated_user" : {
      "user_id" : "",
      "user_name" : "user"
    },
    "created_datetime" : 1607598152997,
    "last_updated_datetime" : 1607598152997
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-rule.query]. Parameter is [X-Auth-Token]. Processor is [header].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

Status code: 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-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"
}