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

Adding a Policy for an Audit Scope

Function

Add a policy for an audit scope.

URI

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

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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

No

String

Operation type. Use commas (,) to separate multiple operation types.

db_ids

Yes

String

Database ID. Use commas (,) to separate multiple IDs. To specify all values, set it to [ALL].

db_names

Yes

String

Database name. Use commas (,) to separate multiple database names. To specify all values, set it to [All databases].

db_users

No

String

Database account. Use commas (,) to separate multiple accounts.

exception_ips

No

String

Exception IP address. Use commas (,) to separate multiple IP addresses.

rule_name

Yes

String

Name

source_ips

No

String

Source IP address. Use commas (,) to separate multiple IP addresses.

source_ports

No

String

Source port. Use commas (,) to separate multiple ports.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Alarm status.

  • SUCCESS: success

  • FAILED: failed

Status code: 400

Table 5 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 6 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 401

Table 7 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 8 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 9 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 10 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 11 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 12 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

{
  "db_ids" : "lQZpwJgB0g4pz3UTv74a",
  "db_names" : "MySQL",
  "rule_name" : "test"
}

Example Responses

Status code: 200

OK

{
  "status" : "SUCCESS"
}

Status Codes

Status Code

Description

200

OK

400

Invalid request parameter.

401

Authorization failed.

403

Unauthorized

500

Server error.

Error Codes

See Error Codes.