Querying the Rule Group List

Function

This API is used to query the rule group list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/data-classification/rule/group

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of items displayed on each page
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
name	No	String	Rule group name.
creator	No	String	Rule group creator.
desc	No	Boolean	Sorting rule
order_by	No	String	Sorting field. The value is createdAt, createdBy, updatedAt, updatedBy, name, description.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
rule_groups	Array of DataClassificationGroupQueryDTO objects	Rule group list.
total	Long	Total number of rule groups.

**Table 5** DataClassificationGroupQueryDTO
Parameter	Type	Description
uuid	String	Rule group ID.
name	String	Rule group name.
rules	Array of DataClassificationRuleQueryDTO objects	Rule entity.
description	String	Rule group description.
created_by	String	Rule group creator.
created_at	Long	Time when a rule group is created.
updated_by	String	Person who updates a rule group.
updated_at	Long	Time when a rule group is updated.
project_id	String	Project ID.

**Table 6** DataClassificationRuleQueryDTO
Parameter	Type	Description
uuid	String	Rule ID.
rule_type	String	Rule type. The options are CUSTOM and BUILTIN.
secrecy_level	String	Security level name.
secrecy_level_num	Long	Confidentiality level.
name	String	Indicates the rule name.
guid	String	guid.
enable	Boolean	Indicates whether the rule is enabled.
method	String	Rule method. The value can be REGULAR, NONE, DEFAULT, or COMBINE.
content_expression	String	Content expression.
column_expression	String	Column expression.
commit_expression	String	Remarks expression.
combine_expression	String	Condition expression
project_id	String	Project ID.
description	String	Specifies the assignment description.
created_by	String	Policy creator.
created_at	Long	Time when a policy is created.
updated_by	String	Person who updates the policy.
updated_at	Long	Time when a policy is updated.
builtin_rule_id	String	ID of a built-in rule.
category_id	String	Category ID.
instance_id	String	Instance ID.
match_type	String	Match type.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

v1/0833a5737480d53b2f25c010dc1a7b88/security/data-classification/rule/group?offset=0&limit=10&name=test_rule_groups

Example Responses

Status code: 200

{
  "rule_groups" : [ {
    "created_at" : 1697600262611,
    "created_by" : "ei_dayu_test_01",
    "description" : "test",
    "name" : "test_rule_group",
    "project_id" : "0833a5737480d512fa51w010dc1a7b88",
    "rules" : null,
    "updated_at" : 1697600262611,
    "updated_by" : "ei_dayu_test_01",
    "uuid" : "8a125fdsesa0b421012saed35c770004"
  } ],
  "total" : 1
}