Help Center/ Database Security Service/ API Reference (Paris and Amsterdam Regions)/ API/ Instance Rule APIs/ Querying a Specified Risk Rule Policy
Updated on 2024-01-15 GMT+08:00
View PDF
Share

Querying a Specified Risk Rule Policy

Function

This API is used to query a specified risk rule policy.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

instance_id

Yes

String

Instance ID

risk_id

Yes

String

Risk Rule ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

rule_id

String

Risk rule ID

rule_name

String

Risk name

status

String

Risk rule status. Enumerated values: OFF ON

action

String

Operation set. Values are separated by commas (,). Allowed operations include: LOGIN CREATE_TABLE CREATE_TABLESPACE DROP_TABLE DROP_TABLESPACE DELETE INSERT INSERT_SELECT SELECT SELECT_FOR_UPDATE UPDATE CREATE_USER DROP_USER GRANT OPERATE ALL

schemas

Array of schemas objects

Schema list

rank

Integer

Risk rule priority

ignore_case

Boolean

Case insensitive or not

risk_level

String

Risk level Enumerated values: LOW MEDIUM HIGH NO_RISK

db_ids

String

Database ID. Values are separated by commas (,). A single ID can contain up to 256 characters.

execution_symbol

String

Relationship between the execution duration and the execution duration threshold Enumerated value: GREATER EQUAL LESS GREATER_EQUAL LESS_EQUAL NO_MATCH

execution_time

Integer

Execution duration threshold

affect_symbol

String

Relationship between the number of affected rows and the row quantity threshold: Enumerated value: GREATER EQUAL LESS GREATER_EQUAL LESS_EQUAL NO_MATCH

affect_rows

Integer

Threshold of affected rows

client_ips

String

Client IP address segment:The value is in the IP-IP format or IP/XX format. IP address segments are separated by commas (,).
Table 4 schemas

Parameter

Type

Description

schema

String

Schema name

table

String

Table

column

String

Column name

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

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

Example Responses

Status code: 200

Success

{
  "status" : "OFF",
  "action" : "LOGIN,SELECT,INSERT",
  "schemas" : [ {
    "schema" : "dbss_audit",
    "table" : null,
    "column" : null
  } ],
  "rank" : 6,
  "ignore_case" : false,
  "rule_id" : "AWT0HznX7At9UslqwTfm",
  "rule_name" : "risk_rule_name_00",
  "risk_level" : "MEDIUM",
  "db_ids" : "11111,22222",
  "execution_symbol" : "GREATER",
  "execution_time" : 10000,
  "affect_symbol" : "GREATER",
  "affect_rows" : 30,
  "client_ips" : "192.168.0.1"
}

Status code: 400

Invalid parameter.

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

Status code: 500

Internal server error.

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

Status Codes

Status Code

Description

200

Success

400

Invalid parameter.

403

Authentication failed.

500

Internal server error.

Error Codes

See Error Codes.

Parent topic: Instance Rule APIs