Querying a Risk Rule Policy

Function

Query a risk rule policy.

URI

GET /v1/{project_id}/audit/{instance_id}/rule/risk

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. You can obtain the value by calling the IAM API for [querying the project list of a specified IAM user]. Constraints N/A Range The value is determined by the value of the IAM API. The value contains 32 to 64 characters. Default Value N/A
instance_id	Yes	String	Definition Instance ID. The value can be obtained from the ID field of the API for querying the instance list. Constraints N/A Range The value is determined by the value of the API for querying the instance list. The value contains 32 to 64 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Risk name
risk_levels	No	String	Definition: Risk level. Constraints: Value range Value range: LOW MEDIUM HIGH NO_RISK Default value: N/A
support_db_classify_rule	No	Boolean	Definition: Whether risk rules can be displayed by database type. Constraints: Value range Value range: true: supported false: not supported false: not supported Default value:
offset	No	String	Definition: Pagination offset. The query starts after the offset of the first data record. Constraints Only integers greater than or equal to 0 are supported. Range: Greater than or equal to 0 Default Value: The default value is 0.
limit	No	String	Definition Number of records queried on each page. Constraints Only integers greater than 0 are supported. Range Greater than 0 and less than or equal to 1000 Default Value The default value is 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. The token can be queried by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints: N/A Value range: You can obtain the value by calling the IAM API used to query a user token. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
rules	Array of rules objects	List of risk rules
total	Integer	Total number.
customize_total	Integer	Number of custom rules

**Table 5** rules
Parameter	Type	Description
id	String	Risk rule ID
name	String	Risk rule name
type	String	Risk rule type. The options are as follows: LOGIN OPERATE
feature	String	Risk rule characteristics
status	String	Risk rule status. The value can be: ON: enabled OFF: disabled
rank	Integer	Risk rule priority. A smaller value indicates a higher priority.
risk_level	String	Risk level. The options are as follows: LOW MEDIUM HIGH NO_RISK
rule_type	String	Rule type. SYSTEM CUSTOMIZE

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 7** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 9** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
details	Array of DbssErrorDetail objects	PDP5 authentication exception information
encoded_authorization_message	String	PDP5 authentication exception information
error_code	String	Error Codes
error_msg	String	Error message.

**Table 11** DbssErrorDetail
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	PDP5 error information

Example Requests

/v1/{project_id}/audit/{instance_id}/rule/risk

Example Responses

Status code: 200

Success

{
  "rules" : [ {
    "id" : "xX4W2ngBo47GiyUSBeOy",
    "name" : "Database_drag_detection",
    "type" : "OPERATE",
    "feature" : "CLIENT[Any]OPERATE[[SELECT]OBJECT[Any]",
    "status" : "ON",
    "rank" : -1,
    "risk_level" : "HIGH"
  }, {
    "id" : "xn4W2ngBo47GiyUSBeP4",
    "name" : "Database_Slow_SQL_Detection",
    "type" : "OPERATE",
    "feature" : "CLIENT[Any]OPERATE[[SELECT]OBJECT[Any]",
    "status" : "ON",
    "rank" : -2,
    "risk_level" : "LOW"
  } ],
  "total" : 2
}