Help Center/ Cloud Search Service/ API Reference/ API V1/ Log Management/ Enabling the Automatic Log Backup Policy

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

View PDF

Enabling the Automatic Log Backup Policy

Function

CSS provides log query and log backup, enabling you to easily manage and analyze logs to efficiently locate faults, optimize performance, and enhance system security.

Log query: On the log management page of the CSS management console, you can query the latest 10,000 log records by node type and other criteria. A maximum of 100 results are displayed, enabling you to quickly locate issues.
Log backup: Cluster logs are periodically synchronized to OBS buckets. You can download them for in-depth analysis at any time. You can configure custom log backup policies by specifying backup schedules and storage locations. The system backs up all critical logs, including run logs and deprecation logs. They provide comprehensive data for auditing and troubleshooting purposes.

This API is used to enable an automatic log backup policy. If log backup is enabled for a cluster, you can use this API to configure an automatic backup policy to periodically back up cluster logs to a specified OBS bucket and directory.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/logs/policy/update

**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 for which automatic log backup is to be enabled. 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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
period	Yes	String	Definition: Log backup start time. Format: Greenwich Mean Time (GMT). Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable the automatic log backup policy.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/policy/update

{
  "period" : "00:00 GMT+08:00"
}

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.