Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Cloud DBA/ Enabling or Disabling SQL Explorer and Slow Query Log

Updated on 2024-09-26 GMT+08:00

View PDF

Enabling or Disabling SQL Explorer and Slow Query Log

Function

SQL Explorer can be enabled and disabled. After this function is enabled, the instance performance loss rate is within 5% and DAS stores all SQL statement logs for analysis. You can set the retention period of SQL explorer data. After the retention period expires, the data is automatically deleted. If not specified, the data is retained for seven days. Slow Query Log can be enabled and disabled. After this function is enabled, DAS stores slow query logs for analysis. You can set the retention period of slow query logs. After the retention period expires, the data is automatically deleted. If not specified, the data is retained for seven days. This function is available only for paid instances.

URI

POST /v3/{project_id}/instances/{instance_id}/sql/switch

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. 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.
X-Language	No	String	Request language type. Enumerated values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Switch type. The value can be DAS SQL Explorer or DAS Slow Query Log.
status	Yes	Integer	Status. The value can be 0 (disabled) or 1 (enabled).
datastore_type	Yes	String	Database type. Currently, SQL Explorer supports RDS for MySQL and GaussDB(for MySQL) databases, and Slow Query Log supports RDS for MySQL, GaussDB(for MySQL), and RDS for PostgreSQL databases.
retention_days	No	Long	SQL data retention period (days). The default value is 7. The maximum retention period is 30 days. Data will be automatically deleted after time expires. If you want to retain the data for more than 30 days, perform operations on the DAS console.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Function status. The options are Enabled, Disabled, and Switching.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum length: 8 characters Maximum length: 36 characters
error_msg	String	Error message. Minimum length: 2 characters Maximum length: 512 characters

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum length: 8 characters Maximum length: 36 characters
error_msg	String	Error message. Minimum length: 2 characters Maximum length: 512 characters

Example Request

Enabling SQL Explorer

POST https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/sql/switch

{
  "type" : "DAS SQL Explorer",
  "status" : 1,
  "datastore_type" : "MySQL",
  "retention_days" : 8
}