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

Modifying Basic Settings for Log Backup or Log Collection

Function

This API is used to modify basic configurations for cluster log backup or real-time log collection. If the log backup or log collection function has been enabled in the cluster, you can use this API to modify the basic configurations of log backup and log collection.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/logs/settings

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 whose basic log configurations you want to modify. 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

Parameter description:

Modifies the settings of log backup or log collection.

Constraints:

N/A

Options:

  • base_log_collect: Modifies log backup settings.

  • real_time_log_collect: Modifies log collection settings.

Default value:

base_log_collect

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

agency

No

String

Definition

Name of the agency that authorizes CSS to store log backup data in specified OBS buckets.

Constraints

This parameter is mandatory when action is set to base_log_collect.

Range

The agency name can contain at most 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Default Value

N/A

log_base_path

No

String

Definition

Storage path of backed up logs in the OBS bucket.

The service will back up logs to the ${Cluster name} directory under the corresponding backup path.

Constraints

This parameter is mandatory when action is set to base_log_collect.

  • The backup path cannot contain the following characters: \:*?"<>|'{}. Additionally, it cannot:

  • Start with a slash (/).

  • Start or end with a period (.).

  • Contain more than two consecutive slashes (/) or periods (.).

  • Exceed 512 characters.

Range

N/A

Default Value

N/A

log_bucket

No

String

Definition

OBS bucket name for log backup.

Constraints

This parameter is mandatory when action is set to base_log_collect.

The bucket name can contain 3 to 63 characters. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.

Range

N/A

Default Value

N/A

auto_enable

No

Boolean

Definition:

Whether to enable automatic backup of cluster logs.

Constraints:

N/A

Value range:

  • true: Enable automatic backup of cluster logs.

  • false: Disable automatic backup of cluster logs.

Default value:

false

period

No

String

Definition:

Cluster log backup start time.

Constraints:

Format: Greenwich Mean Time (GMT).

Value range:

N/A

Default value:

N/A

index_prefix

No

String

Definition:

Index prefix for storing logs.

Constraints:

This parameter is mandatory when action is set to real_time_log_collect.

Value range:

The index name can contain 1 to 128 characters. Only digits, lowercase letters, underscores (_), and hyphens (-) are allowed.

Default value:

N/A

keep_days

No

Integer

Definition

Number of days for log retention.

Constraints

This parameter is mandatory when action is set to real_time_log_collect.

Range

1 to 3,650 (days)

Default Value

N/A

target_cluster_id

No

String

Definition

ID of the target cluster for log storage. For details, see Obtaining the Cluster ID.

Constraints

  • This parameter is mandatory when action is set to real_time_log_collect.

  • The target cluster can be the current cluster or another cluster. If logs are saved to another cluster, you need to use the connectivity test API to test connectivity to the target cluster. If status code 200 is returned, the target cluster can be reached. Otherwise, you need to select another cluster.

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

  • Modify log backup settings.

    POST https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/logs/settings

{
  "agency" : "css_obs_agency",
  "log_base_path" : "css_repository/logs",
  "log_bucket" : "000-words",
  "auto_enable" : true,
  "period" : "00:00 GMT+08:00"
}

  • Modify real-time log ingestion settings.

    POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/settings?action=real_time_log_collect

{
  "index_prefix" : "css_log",
  "keep_days" : 30,
  "target_cluster_id" : "4f3deec3-efa8-4598-bf91-560aad1377a3"
}

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