Help Center/ Data Admin Service/ API Reference/ APIs (in OBT)/ Cloud DBA/ Querying Whether SQL Explorer and Slow Query Log Are Enabled
Updated on 2024-12-04 GMT+08:00
View PDF
Share

Querying Whether SQL Explorer and Slow Query Log Are Enabled

Function

This API is used to query whether SQL Explorer and Slow Query Log are enabled. This function is available only for paid instances.

URI

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

Table 1 Path 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.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Switch type. The value can be DAS SQL Explorer or DAS Slow Query Log.

datastore_type

Yes

String

Database type. SQL Explorer is supported for MySQL and TaurusDB. Slow Query Log is supported for MySQL, TaurusDB, and PostgreSQL.

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Function status. The value can be Enabled, Disabled, or Switching.

retention_days

Long

Number of days during which SQL data is retained.

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

Querying whether Slow Query Log is enabled

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/da304cd5bbb944de828759bc7be3d3fein01/sql/switch?type=DAS Slow Query Log&datastore_type=MySQL

Example Response

Status code: 200

DAS status response body

{
  "status" : "Enabled",
  "retention_days" : 7
}

Status Codes

Status Code

Description

200

DAS status response body.

400

Client error.

500

Server error.

Error Codes

For details, see Error Codes.

Parent topic: Cloud DBA