Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Log Management/ Querying Whether SQL Explorer Is Enabled
Updated on 2023-10-18 GMT+08:00
View PDF

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

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

switch_status

String

Whether SQL Explorer is enabled.

Value:

  • ON: SQL Explorer is enabled.
  • OFF: SQL Explorer is 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