Help Center/ Database Security Service/ API Reference/ API/ Audit Rules - Audit Scope/ Querying the Policy List of an Audit Scope
Updated on 2025-09-10 GMT+08:00

Querying the Policy List of an Audit Scope

Function

Query the policy list of an audit scope.

URI

GET /v1/{project_id}/audit/{instance_id}/rule/scopes

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

offset

No

String

Definition

Pagination offset. The query starts after the offset of the first data record.

Constraints

Only integers greater than or equal to 0 are supported.

Range

Greater than or equal to 0

Default Value

The default value is 0.

limit

No

String

Definition

Number of records queried on each page.

Constraints

Only integers greater than 0 are supported.

Range

Greater than 0 and less than or equal to 10000

Default Value

The default value is 100.

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

scopes

Array of RuleScopeInfo objects

Audit scope rule list

total

Integer

Total number

Table 5 RuleScopeInfo

Parameter

Type

Description

id

String

Audit scope rule ID

name

String

Audit scope name

action

String

Actions in the audit scope

status

String

Audit scope rule status

exception_ips

String

Exception IP address of the audit scope

source_ips

String

Source IP address of the audit scope rule

source_ports

String

Port of the audit scope rule

db_ids

String

Database ID.

db_names

String

Database name

db_users

String

Database user.

all_audit

Boolean

Whether to perform full audit.

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

Example Responses

Status code: 200

Success

{
  "scopes" : [ {
    "id" : "zX4W2ngBo47GiyUSBuNs",
    "name" : "Full audit rules",
    "action" : "",
    "status" : "ON",
    "exception_ips" : "",
    "source_ips" : "",
    "source_ports" : "",
    "db_ids" : "",
    "db_names" : "",
    "db_users" : "",
    "all_audit" : true
  } ],
  "total" : 1
}

Status Codes

Status Code

Description

200

Success

400

Incorrect request parameter.

403

Authorization failed.

500

Internal server error.

Error Codes

See Error Codes.