Help Center/ Cloud Search Service/ API Reference (Kuala Lumpur Region)/ API V1/ Log Management/ Disabling the Log Backup or Collection Function
Updated on 2026-09-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Disabling the Log Backup or Collection Function

Function

This API is used to disable log backup or log ingestion for a cluster. When log backup or log ingestion is no longer required, you can disable it to reduce storage costs.

Constraints

  • Disabling log backup does not automatically delete existing log backups. Instead, you need to manually delete them on the OBS console.

  • Disabling log ingestion does not automatically remove ingested log data. Rather, it will be deleted by the system upon expiration of its retention period. You can also manually delete it from the target cluster before the retention period expires.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/logs/close

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

Constraints

N/A

Range

Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits.

Default Value

N/A

cluster_id

Yes

String

Definition

ID of the cluster for which log backup or ingestion is to be disabled. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints

N/A

Range

The value is a UUID containing 36 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action

No

String

Definition:

Disables log backup or log collection.

Constraints:

You can disable log backup or log collection only when it is enabled. For details about how to enable log backup or log ingestion, see Enabling Logs.

Value range:

  • base_log_collect: Disables log backup.

  • real_time_log_collect: Stops log ingestion.

Default value:

base_log_collect

Request Parameters

None

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

  • Disable log backup.

    PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/close?action=base_log_collect

  • Disable log ingestion.

    PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/close?action=real_time_log_collect

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

409

The request could not be completed due to a conflict with the current state of the resource.

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

412

The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.

Parent topic: Log Management