Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Logs/ Setting the Desensitization Status of Slow Query Logs
Updated on 2025-11-27 GMT+08:00
View PDF
Share

Setting the Desensitization Status of Slow Query Logs

Function

This API is used to set the desensitization status of slow query logs.

Constraints

This API supports the following types of instances:

  • GeminiDB Mongo

After desensitization is disabled, it cannot be enabled.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:updateSlowLogPlaintextSwitch

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:modifySlowLogPlaintextSwitch

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/slowlog-desensitization

Table 1 Path 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 can be obtained by calling the API described in Querying Instances and Details. If there are no instances available, call the API described in Creating an Instance to create one.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

desensitization_status

Yes

String

Whether slow query log desensitization is enabled. The value can be:

  • off, indicating that desensitization is disabled.

Response Parameters

Status code: 204

No response parameters

Example Request

  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in10/slowlog-desensitization
  • Disabling data masking 
    { 
  "desensitization_status" : "off" 
}

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Logs