Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Log Management/ Querying Whether Error Log Collection Is Enabled
Updated on 2024-08-20 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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/error-log/switch/status

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

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

Default value:

None

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Table 2 Response Parameters

Parameter

Type

Description

status

String

Whether error log collection is enabled.

  • 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 Code

Error Code

For details, see Error Codes.