Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Log Management/ Querying Whether SQL Explorer Is Enabled
Updated on 2025-09-04 GMT+08:00
View PDF
Share

Querying Whether SQL Explorer Is Enabled

Function

This API is used to query whether SQL Explorer is enabled. Before calling this API:

URI

GET /v3/{project_id}/instance/{instance_id}/audit-log/switch-status

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

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

switch_status

String

Definition

Whether SQL Explorer is enabled.

Range

  • ON: enabled

  • OFF: disabled

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying whether SQL Explorer is enabled

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/61a4ea66210545909d74a05c27a7179ein07/audit-log/switch-status

Example Response

Status code: 200

Success.

{
  "switch_status" : "ON"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Log Management