Adding a Risk Rule

Function

Adding a Risk Rule

URI

POST /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

Request Parameters

**Table 2** 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	No	String	Operation type. Use commas (,) to separate multiple operation types.
affect_rows	Yes	Integer	Number of rows affected.
affect_symbol	Yes	String	Operator of the number of affected rows. The value can be: GREATER EQUAL LESS GREATER_EQUAL: greater than or equal to LESS_EQUAL: less than or equal to NO_MATCH: not equal to
client_ips	No	String	Client IP address. Use commas (,) to separate multiple IP addresses.
db_ids	No	String	Database ID. Use commas (,) to separate multiple IDs.
exception_ips	No	String	Exception IP addresses. The IP addresses specified here are not checked for risk matching. Use commas (,) to separate multiple IP addresses.
execution_symbol	Yes	String	Execution duration operator. The options are as follows: GREATER EQUAL LESS GREATER_EQUAL: greater than or equal to LESS_EQUAL: less than or equal to NO_MATCH: not equal to
execution_time	Yes	Long	Execution duration.
ignore_case	No	Boolean	Case insensitive or not.
risk_level	Yes	String	Risk severity. LOW: low MEDIUM: medium HIGH: high NO_RISK: none
rule_name	Yes	String	Rule name.
schemas	No	Array of SchemaBean objects	Operation object.
status	Yes	String	Status. OFF: disabled ON: enabled

**Table 4** SchemaBean
Parameter	Mandatory	Type	Description
column	No	String	Target field.
schema	No	String	Destination database.
table	No	String	Target table.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
status	String	Status. The options are as follows: SUCCESS FAILED

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: 401

**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: 403

**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

Status code: 500

**Table 12** 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 13** 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

{
  "rule_name" : "test",
  "risk_level" : "LOW",
  "status" : "ON",
  "affect_rows" : 0,
  "affect_symbol" : "GREATER_EQUAL",
  "execution_symbol" : "GREATER_EQUAL",
  "execution_time" : 0,
  "db_ids" : "lQZpwJgB0g4pz3UTv74a",
  "client_ips" : "10.0.1.2,10.2.3.3",
  "schemas" : [ ],
  "ignore_case" : false,
  "action" : null,
  "exception_ips" : "10.0.1.2,10.2.3.3"
}