Help Center/ Database Security Service/ API Reference/ API/ Dashboard/ Obtaining the Risk Summary of All Instances of a Tenant
Updated on 2025-09-10 GMT+08:00

Obtaining the Risk Summary of All Instances of a Tenant

Function

Obtain the risk summary of all the instances of a tenant.

URI

GET /v1/{project_id}/audit/summary/risk/statistics

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

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. (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 3 Response body parameters

Parameter

Type

Description

db_risk_statistics

Array of DatabaseRiskStatisticsDto objects

Database Risk Statistics

high_risk_total

Long

Total High Risks

low_risk_total

Long

Low-risk quantity

medium_risk_total

Long

Total Medium Risks

project_id

String

Project ID

rule_risk_statistics

Array of RuleRiskStatisticsDto objects

Risk Rule Statistics

unsupported_audit_infos

UnSupportAuditInfoResponse object

Audit is not supported.

update_time

Long

Update time.

Table 4 DatabaseRiskStatisticsDto

Parameter

Type

Description

db_id

String

The database record ID.

db_ip

String

Database IP address

db_name

String

Database name

high_risk

Long

Total High Risks

instance_id

String

Instance ID

instance_name

String

Instance name

low_risk

Long

Low-risk quantity

medium_risk

Long

Total Medium Risks

risk_rule

Array of RiskRuleStatistic objects

Risk Rule Statistics

total_risk

Long

Total number of risks

Table 5 RiskRuleStatistic

Parameter

Type

Description

count

Long

Quantity

rule_name

String

Rule Name

rule_name_english

String

Rule Name (En)

Table 6 RuleRiskStatisticsDto

Parameter

Type

Description

count

Long

Quantity

instance_risk_count

Array of AuditInsanceRiskCount objects

Instance database risk summary

rule_name

String

Rule name.

Table 7 AuditInsanceRiskCount

Parameter

Type

Description

count

Long

Risks

db_id

String

The database record ID.

db_ip

String

Database IP address

db_name

String

Database name

instance_id

String

Instance ID

instance_name

String

Instance name

Table 8 UnSupportAuditInfoResponse

Parameter

Type

Description

audit_infos

Array of UnSupportAuditInfo objects

Audit information

support_version

String

Supported version

Table 9 UnSupportAuditInfo

Parameter

Type

Description

audit_version

String

Instance version

server_name

String

Pod name

Status code: 400

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

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

Status code: 403

Table 14 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 15 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 16 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 17 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v1/{project_id}/audit/summary/risk/statistics

Example Responses

Status code: 200

OK

{
  "project_id" : "b9351f98c724428794ba7d105fa3558d",
  "update_time" : 1753427747773,
  "high_risk_total" : 11,
  "medium_risk_total" : 1,
  "low_risk_total" : 0,
  "unsupported_audit_infos" : {
    "support_version" : "23.11.14.095000",
    "audit_infos" : [ ]
  },
  "rule_risk_statistics" : [ {
    "count" : 11,
    "rule_name" : "Dirty table abnormal enable test",
    "instance_risk_count" : [ {
      "count" : 11,
      "instance_id" : "003a3add086d5617bb0e416eac5bfffd",
      "instance_name" : "DBSS-chen2504-DoNotDelete",
      "db_id" : "fTZDOpgB2XtjGzFKOmK4",
      "db_name" : "zyb-test",
      "db_ip" : "10.0.147.151"
    } ]
  } ],
  "db_risk_statistics" : [ {
    "db_id" : "fTZDOpgB2XtjGzFKOmK4",
    "db_name" : "zyb-test",
    "db_ip" : "10.0.147.151",
    "instance_name" : "DBSS-chen2504-DoNotDelete",
    "instance_id" : "003a3add086d5617bb0e416eac5bfffd",
    "high_risk" : 11,
    "medium_risk" : 1,
    "low_risk" : 0,
    "total_risk" : 12,
    "risk_rule" : [ {
      "rule_name" : "Dirty table abnormal enable test",
      "rule_name_english" : "Dirty table abnormal enable test",
      "count" : 11
    }, {
      "rule_name" : "UNION Query SQL Injection",
      "rule_name_english" : "UNION_QUERY",
      "count" : 1
    } ]
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.