Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Log Management/ Enabling or Disabling Error Log Collection
Updated on 2026-07-16 GMT+08:00

Enabling or Disabling Error Log Collection

Function

This API is used to enable or disable database error log collection. Before calling this API:

Debugging

You can debug this API in API Explorer.

Constraints

This operation cannot be performed when the instance is in any of the following statuses: creating, changing instance specifications, changing port, frozen, or abnormal.

URI

POST /v3/{project_id}/instances/{instance_id}/error-log/switch/{status}

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. For details about how to obtain the instance ID, see Querying DB Instances.

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 a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us

Response Parameters

None

Example Request

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/0317e6bbae534b8eb8f74f0eafcf1d3din01/error-log/switch/ON

Example Response

"success"

Status Codes

Error Codes

For details, see Error Codes.