Enabling Log Backup or Log Collection

Function

This API is used to enable log backup or log ingestion for a cluster. Log backup and log ingestion can be enabled separately. After log backup is enabled, you can configure an automatic backup policy or manually trigger backup to back up the cluster's run logs to a specified OBS bucket and directory. After log collection is enabled, the cluster's run logs will be collected in real time and saved to a specified index of a specified cluster.

Calling Method

For details, see Calling APIs.

URI

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

**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 log backup or ingestion 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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
action	No	String	Parameter description: Configure log backup or log collection for a cluster. Constraints: N/A Options: base_log_collect: Backs up logs to OBS. real_time_log_collect: Saves logs to an Elasticsearch cluster in real time. Default value: base_log_collect

Request Parameters

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
agency	No	String	Parameter description: Agency name. Through this agency, you delete OBS permissions to CSS, so that CSS will be able to back up log files to your OBS buckets. Constraints: This parameter is mandatory when action is not set to real_time_log_collect. Options: 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. Constraints: This parameter is mandatory when action is not set to real_time_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 not set to real_time_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	Parameter description: Index prefix for storing logs. Constraints: This parameter is mandatory when action is set to real_time_log_collect. Options: N/A 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 target cluster for log storage. Constraints: The target cluster can be the current cluster or another Elasticsearch cluster. If logs are saved to another cluster, you need to use the connectivity testing 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 target cluster. This parameter is mandatory when action is set to real_time_log_collect. Value range: N/A Default value: N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable the log backup function.

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

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

Enable real-time log collection function.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/logs/open?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.