Help Center/ Cloud Search Service/ API Reference (Kuala Lumpur Region)/ API V1/ Snapshot Management/ Enabling or Modifying the Cluster Snapshot Function
Updated on 2026-09-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling or Modifying the Cluster Snapshot Function

Function

This API is used to enable or modify the snapshot function of an Elasticsearch/OpenSearch cluster. The snapshot backup and restoration function provides data protection and restoration capabilities for a cluster. Through snapshot backup, the data status of a cluster can be saved to an OBS bucket for restoration when needed.

When enabling or modifying the cluster snapshot function, you can enable or disable the automatic snapshot creation function.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting

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

Cluster ID. 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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

bucket

Yes

String

Definition

Name of the OBS bucket that stores snapshots.

Constraints

  • The storage class must be Standard.

  • The region must be the same as the region where the cluster is located.

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

Range

N/A

Default Value

N/A

agency

Yes

String

Definition

Agency name. Select an IAM agency to grant the current account the permission to access and use OBS. To store snapshots to an OBS bucket, you must have the required OBS access permissions.

Constraints

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

Range

N/A

Default Value

N/A

base_path

No

String

Definition

Snapshot storage path in the OBS bucket.

Constraints

  • 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

max_snapshot_bytes_per_seconds

No

String

Definition

Configures the maximum backup rate per node (per second). If the backup rate exceeds this value, throttling is applied to prevent excessive resource usage and protect system stability. The actual backup rate may not reach this value due to factors such as OBS and disk performance.

Constraints

N/A

Range

The following three input formats are supported:

  • Number + Unit

  • 0

  • -1

The numeric part supports values from 0 to 9999.

The unit supports k, kb, m, mb, g, gb, t, tb, p, pb, and b, case-insensitive.

If you set the parameter to 0mb, 0, or -1, the backup rate is unlimited. If the backup rate is too high, backup operations may consume excessive resources and affect system stability.

Default Value

The default value is 40mb. If this parameter is left blank, the default value is used.

max_restore_bytes_per_seconds

No

String

Definition:

This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

Constraints:

For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.

Value range:

The following values and formats are allowed:

  • Number + Unit

  • 0

  • -1

The number ranges from 0 to 9999.

The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).

Setting this parameter to 0mb, 0, -1 means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability.

Default value:

For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40 MB.

For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter.

If this parameter is left blank, the default setting is used.

enable

No

String

Definition:

Whether to enable automatic snapshot creation.

Constraints:

N/A

Value range:

  • true: Enable automatic snapshot creation.

  • false: Disable automatic snapshot creation.

Default value:

false

indices

No

String

Definition

Names of the indexes to be backed up.

  • You can specify indices, separated by commas (,), for example, index1,index2,index3.

  • You can use an asterisk () to match multiple indexes. For example, index indicates that all indexes with the prefix index will be restored.

Constraints

N/A

Range

0 to 1024 characters. Uppercase letters, spaces, or the following special characters are not allowed: "<|>/?

Default Value

Empty by default, indicating that all indexes are backed up.

prefix

No

String

Definition:

Prefix of the name of an automatically created snapshot. A snapshot name consists of the snapshot name prefix and timestamp, for example, snapshot-1566921603720.

Constraints:

This parameter is mandatory when enable is set to true.

Value range:

Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

period

No

String

Definition:

Time when a snapshot is created every day.

Constraints:

NOTE:
When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.

Value range:

Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

Default value:

00:00 GMT+08:00

keepday

No

Integer

Definition

Customize the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to auto snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

Constraints

  • This parameter is mandatory when enable is set to true.

  • The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value.

Range

1 to 90

Default Value

N/A

frequency

No

String

Definition:

Frequency of automatically creating snapshots.

Constraints:

The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value.

Value range:

  • HOUR: Execute once every hour on the hour.

  • DAY: Execute once every day.

  • SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.

Default value:

DAY

delete_auto

No

String

Definition:

Whether to clear all the automatically created snapshots when disabling automatic snapshot creation.

Constraints:

This parameter takes effect only when enable is set to false.

Value range:

true: Delete all automatically created snapshots when automatic snapshot creation is disabled.

false: Do not delete snapshots that were automatically created.

Default value:

false

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable the snapshot function but do not enable automatic snapshot creation.

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

{
  "bucket" : "test-bucket",
  "agency" : "usearch",
  "base_path" : "css_repository/Es-name",
  "max_snapshot_bytes_per_seconds" : "0",
  "max_restore_bytes_per_seconds" : "0"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

406

The server could not fulfill the request according to the content characteristics of the request.

412

The server did not meet one of the preconditions contained in the request.

504

A gateway timeout error occurred.

Error Codes

See Error Codes.

Parent topic: Snapshot Management