Enabling Log Backup or Log Collection

Function

This API is used to enable log backup or log ingestion for a cluster. You can enable log backup and log ingestion separately.

Log backup: Cluster logs are periodically synchronized to OBS buckets. You can download them for in-depth analysis at any time.
Log ingestion: Cluster logs are transmitted in real time to the current cluster or another cluster on the same network. (Relevant version and network compatibility requirements must be met.) You can use Kibana or other visualization tools for log search and analysis.

Constraints

Log ingestion is supported only when the Elasticsearch cluster version is 7.10.2 and the image version is no earlier than 7.10.2_24.2.0_×.×.×.
Log ingestion is supported only when the OpenSearch cluster version is 1.3.6 or 2.19.0 and the image version is no earlier than ×.×.×_24.2.0_×.×.×.

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 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 enabled. 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: Configure log backup or log ingestion for a cluster. Constraints: N/A Value range: base_log_collect: Enables log backup. real_time_log_collect: Enables log ingestion. Default value: base_log_collect

Request Parameters

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
agency	No	String	Definition Agency name, which is the agency delegated to CSS to authorize CSS to store logs in the OBS bucket. Constraints This parameter is mandatory when action is set to base_log_collect. Range The agency name can contain up to 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 ${[/topic/body/section/table/tgroup/tbody/row/entry/p/b/br {""}) (br]} 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. Range The bucket name can contain 3 to 63 characters. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed. 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: This parameter is mandatory when action is set to base_log_collect and auto_enable is set to true. Value range: Format: Greenwich Mean Time (GMT). Example: 00:00 GMT+08:00 Default value: N/A
index_prefix	No	String	Definition: Index prefix used for log ingestion. The log index is named using the format "index prefix+Log ingestion date". 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 Log retention period. Ingested logs will be deleted upon expiration of this period. 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 you select another cluster, you need to use the log collection connectivity test API to verify whether the cluster can be used as the target cluster. If the status code is 200, it can be used as the target cluster. Otherwise, it cannot. 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.

Error Codes

See Error Codes.

Parent topic: Log Management

Previous topic: Log Management

Next topic: Disabling the Log Backup or Collection Function