Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ SQL Explorer/ Disabling SQL Explorer
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Disabling SQL Explorer

Function

This API is used to disable SQL Explorer. After SQL Explorer is disabled, the Agent on instances stops collecting full SQL statement data recorded by the kernel in real time.

Debugging

You can debug this API in API Explorer.

URI

POST /v3/{project_id}/instances/{instance_id}/full-sqls/stop

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

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

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

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

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

N/A

Example Request

Disabling SQL Explorer

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/cf9c879513144362bce2b3760ed81d3bin14/full-sqls/stop

Example Response

{
    "job_id":"4cf79c7f-63a6-4db4-b606-e8c6448d67cb"
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: SQL Explorer