Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Intelligent O&M/ Enabling or Disabling Collect All Query Logs and Collect Slow Query Logs
Updated on 2025-05-19 GMT+08:00

Enabling or Disabling Collect All Query Logs and Collect Slow Query Logs

Function

Collect All Query Logs can be enabled and disabled. After it is enabled, the instance performance loss rate is within 5% and DAS stores all SQL query logs for analysis. You can set the retention period of all query logs. They will be automatically deleted after the retention period expires. If you do not set the retention period, the logs are retained for seven days by default. Collect Slow Query Logs 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

Explanation:

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

instance_id

Yes

String

Explanation:

Unique ID of an instance

Constraints:

N/A

Values:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Explanation:

Switch type

Constraints:

N/A

Values:

  • DAS SQL Explorer: Collect All Query Logs
  • DAS Slow Query Log: Collect Slow Query Logs

Default value:

N/A

status

Yes

Integer

Explanation:

Switch status

Constraints:

N/A

Values:

  • 0: disabled
  • 1: enable

Default value:

N/A

datastore_type

Yes

String

Explanation:

Database type

Constraints:

Collect All Query Logs is available to MySQL and TaurusDB. Collect Slow Query Logs is available to MySQL, TaurusDB, and PostgreSQL.

Values:

  • MySQL
  • TaurusDB
  • PostgreSQL

Default value:

N/A

retention_days

No

Long

Explanation:

SQL data retention period (days)

Constraints:

N/A

Values:

[1,30]

Default value:

7 days

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

status

String

Explanation:

Switch status

Values:

  • Enabled: The function is enabled.
  • Disabled: The function is disabled.
  • Switching: The status is being switched.

Example Request

Enabling Collect All Query Logs

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
}

Example Response

Status code: 200

Response body

{
  "status" : "Enabled"
}

Status Codes

Status Code

Description

200

Response body.

400

Client error.

500

Server error.

Error Codes

See Error Codes.