Enabling or Disabling SQL Explorer

Function

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

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

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

**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, which is compliant with the UUID format.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Values: en-us zh-cn

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
switch_status	Yes	String	Whether SQL Explorer is enabled. Values: ON: SQL Explorer is enabled. OFF: SQL Explorer is disabled.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
result	String	Result for enabling or disabling SQL Explorer.

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"
}