Updated on 2025-09-10 GMT+08:00

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:

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

Determined by the value of the IAM API used for querying user tokens.

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

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.

  • LOW

  • MEDIUM

  • HIGH

  • NO_RISK

rule_type

String

Rule type

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
}

Status Codes

Status Code

Description

200

Success

400

Incorrect request parameter.

403

Authorization failed.

500

Internal server error.

Error Codes

See Error Codes.