Help Center/ Database Security Service/ API Reference/ API Description/ Auditing a Database/ Enabling or Disabling Database
Updated on 2026-01-22 GMT+08:00
View PDF
Share

Enabling or Disabling Database

Function

Enabling or Disabling Database

URI

POST /v3/{project_id}/audit/{instance_id}/databases/switch

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.

** Restrictions**:

N/A

Range:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

** Default value**:

N/A

instance_id

Yes

String

** Parameter description**:

Instance ID. The value can be obtained from the ID field of the API for querying the instance list.

** Restrictions**:

N/A

** Value range**:

The value is subject to 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 used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

N/A

Value range:

You can obtain the value by calling the IAM API used to query a user token.

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Database ID, which can be obtained from the ID field of the API for querying the database list.

status

Yes

String

Switch status.

  • ON: enabled

  • OFF: disabled

lts_audit_switch

No

Integer

Whether to disable LTS audit, which is used in the DWS database scenario. If you do not disable LTS audit, no operation is required.

  • 1: yes.

  • 0 or others: remain unchanged

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Status. The options are as follows:

  • SUCCESS

  • 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: 403

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

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

Example Requests

/v3/{project_id}/audit/{instance_id}/databases/switch

{
  "id" : "Gadr-Y4B51p4J06s5s5B",
  "status" : "OFF"
}

Example Responses

Status code: 200

Success

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Success

400

Failed

403

Authorization failed.

500

Server error.

Error Codes

See Error Codes.

Parent topic: Auditing a Database