Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Log Management/ Enabling or Disabling SQL Explorer
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling or Disabling SQL Explorer

Function

This API is used to enable or disable SQL Explorer. If SQL Explorer is disabled, SQL Explorer may become unavailable for DAS and DBSS. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:auditlog:operate

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:instance:modifyTraceSQLPolicy

    -

URI

POST /v3/{project_id}/instance/{instance_id}/audit-log/switch

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

switch_status

Yes

String

Definition

Whether SQL Explorer is enabled.

Constraints

N/A

Range

  • ON: enabled

  • OFF: disabled

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

result

String

Definition

Results for enabling or disabling SQL Explorer.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Enabling SQL Explorer

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/status
{
  "switch_status" : "ON"
}

Example Response

Status code: 200

Success.

{
  "result" : "success"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Log Management