Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Log Management/ Querying Whether Error Log Collection Is Enabled
Updated on 2025-08-11 GMT+08:00

Querying Whether Error Log Collection Is Enabled

Function

This API is used to query whether error log collection is enabled. Before calling this API:

URI

GET /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.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

None

Response Parameters

Table 2 Response Parameters

Parameter

Type

Description

status

String

Definition

Collection status.

Range

  • ON: enabled
  • OFF: disabled

Example Request

GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/0317e6bbae534b8eb8f74f0eafcf1d3din01/error-log/switch/status
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/0317e6bbae534b8eb8f74f0eafcf1d3din01/error-log/switch/status

Example Response

{
"status":"OFF"
}

Status Codes

Error Codes

For details, see Error Codes.