Help Center/ Database Security Service/ API Reference/ API/ Audit Rules/ Querying a Risk Rule Policy
Updated on 2025-06-19 GMT+08:00
View PDF

Querying a Risk Rule Policy

Function

This API is used to query a risk rule policy.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID. You can obtain the value from the ID field in the API for querying the instance list.
Table 2 Query parameter

Parameter

Mandatory

Type

Description

name

No

String

Risk name

risk_levels

No

String

Risk severity.

  • LOW
  • MEDIUM
  • HIGH
  • NO_RISK

Request Parameter

Table 3 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

User token. The token can be queried by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Parameter Type

Description

rules

Array of rules objects

List of risk rules

total

Integer

Total number
Table 5 rules

Parameter

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 severity.

  • LOW
  • MEDIUM
  • HIGH
  • NO_RISK]

rule_type

String

Rule types. The value can be:

  • SYSTEM: system rule
  • NULL: user-defined rules

Status code: 400

Table 6 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 7 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 8 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 9 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 10 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 11 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

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

Example Response

Status code: 200

Succeeded

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

Status code: 400

Request Parameter Error

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status code: 500

Internal server error.

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Code

Status Code

Description

200

Request succeeded.

400

Incorrect request parameter.

403

Authentication failed.

500

Internal server error.

Error Codes

For details, see Error Codes.

Parent topic: Audit Rules