Help Center/ Cloud Search Service/ API Reference/ API V1/ Log Management/ Modifying Basic Settings for Log Backup or Log Collection

Updated on 2025-11-28 GMT+08:00

View PDF

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 Value range: Project ID of the account. 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 Value range: Cluster ID. 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: Agency name that authorizes CSS to store snapshots in specified OBS buckets. Constraints: This parameter is mandatory when action is set to base_log_collect. Value range: The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters. 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. Value range: 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. 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. Value 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	Parameter description: Number of days for log retention. Constraints: This parameter is mandatory when action is set to real_time_log_collect. Options: 1-3650 Default value: N/A
target_cluster_id	No	String	Definition: ID of the destination cluster for log storage. Constraints: This parameter is mandatory when action is set to real_time_log_collect. The destination cluster can be the current cluster or another cluster. If logs are saved to another cluster, you need to use the connectivity testing API to test connectivity to the destination cluster. If status code 200 is returned, the destination cluster can be reached. Otherwise, you need to select another cluster. Value 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/4f3deec3-efa8-4598-bf91-560aad1377a3/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.