Help Center/ Database Security Service/ API Reference/ API/ Auditing a Database/ Enabling or Disabling Database
Updated on 2025-06-19 GMT+08:00
View PDF

Enabling or Disabling Database

Function

This API is used to enable and disable the database.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 URI parameter

Parameter

Mandatory

Parameter Type

Description

project_id

Yes

String

Project ID.

instance_id

Yes

String

Instance ID. You can obtain the value from the ID field in the API for querying the instance list.

Request Parameter

Table 2 Request header parameter

Parameter

Mandatory

Parameter Type

Description

X-Auth-Token

Yes

String

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.)
Table 3 Request body parameter

Parameter

Mandatory

Parameter 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 GaussDB(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 parameter

Parameter

Parameter Type

Description

status

String

Response status

Status code: 400

Table 5 Response body parameter

Parameter

Parameter Type

Description

error

Object

Error message.
Table 6 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 403

Table 7 Response body parameters

Parameter

Parameter Type

Description

error

Object

Error message.
Table 8 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Parameter Type

Description

error

Object

Error message.
Table 10 ErrorDetail

Parameter

Parameter Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

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

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

Response Examples

Status code: 200

Succeeded

{
  "status" : "SUCCESS"
}

Status code: 400

Failed

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

Status Code

Status Code

Description

200

Success

400

Failed

403

Authentication failed.

500

Server error.

Error Codes

For details, see Error Codes.

Parent topic: Auditing a Database