Help Center/ Cloud Search Service/ API Reference/ API V2/ Snapshot Management/ Enabling Automatic Snapshot Creation
Updated on 2025-09-10 GMT+08:00

Enabling Automatic Snapshot Creation

Function

CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual.

  • Automatic snapshot creation: Snapshots are created periodically based on a preset time policy, for example, daily or weekly, to ensure continuous data protection. This reduces manual effort and improves backup reliability and efficiency.

  • Manual snapshot creation: You create snapshots manually for special occasions, for example, prior to a high-risk operation (such as a cluster upgrade). This ensures you can restore data using snapshots in case anything should go wrong. Manual snapshots provide additional flexibility.

This API is used to enable automatic snapshot creation.

Calling Method

For details, see Calling APIs.

URI

POST /v2.0/{project_id}/clusters/{cluster_id}/snapshots/policy/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 that the snapshot belongs to. 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

indices

No

String

Definition:

Name of an index to be backed up. Multiple indexes are separated by commas (,). By default, all indexes are backed up. You can use the combination of a backslash and an asterisk (*) to back up data of certain indexes. For example, if you specify 2018-06*, then the data of the indexes with the prefix 2018-06 will be backed up.

Constraints:

N/A

Value range:

The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and the following special characters are not allowed: "\<|>/?

Default value:

N/A

keepday

Yes

Integer

Definition:

Set 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:

N/A

Value range:

1–90

Default value:

N/A

frequency

No

String

Definition:

Frequency of automatically creating snapshots.

Constraints:

N/A

Value range:

N/A

Default value:

DAY

When the value is HOUR, the task is executed every hour. When the value is DAY, the scheduled task is executed every day. When the parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. 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. Set this value based on actual conditions.

period

Yes

String

Definition:

Time when a snapshot is created every day.

Constraints:

N/A

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

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.

prefix

Yes

String

Definition:

Prefix of a snapshot that is automatically created, which is manually entered.

Constraints:

N/A

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

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Enable the automatic backup function.

POST https://{Endpoint}/v2.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/snapshots/policy/open

{
  "indices" : "*",
  "keepday" : 7,
  "frequency" : "DAY",
  "period" : "16:00 GMT+08:00",
  "prefix" : "snapshot"
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

403

Request rejected.The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.

Error Codes

See Error Codes.