Modifying Basic Configurations of a Cluster Snapshot

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 target cluster 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

bucket

Yes

String

Definition:

Name of the OBS bucket used for backup.

Constraints:

• Storage class: standard.

• Region: the same as that of the cluster.

Value range:

N/A

Default value:

N/A

agency

Yes

String

Definition:

Agency name. You can create an agency to allow CSS to call other cloud services.

Constraints:

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.

Value range:

N/A

Default value:

N/A

base_path

No

String

Definition:

Storage path of the snapshot in the OBS bucket.

Constraints:

N/A

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

max_snapshot_bytes_per_seconds

No

String

Definition:

This parameter sets the maximum backup 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 backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.

Constraints:

N/A

Value range:

The following values and formats are allowed:

• Number + Unit

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).

0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

• 0

There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

• -1

There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.

Default value:

The default value is 40 MB. 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

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).

0mb 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. Therefore, set this parameter carefully.

• 0

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. Therefore, set this parameter carefully.

• -1

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. Therefore, set this parameter carefully.

Default value:

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

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 the automatic snapshot creation policy.

Constraints:

N/A

Value range:

true: The automatic snapshot creation policy is enabled.

false: disabled.

Default value:

false

indices

No

String

Definition:

Name of the index to be backed up.

Constraints:

• indicates all indexes and is valid only when enable is set to true.

• The value cannot contain uppercase letters, spaces, or the following characters: "<|>/?

Value range:

• If this parameter is left blank, all indexes in the snapshot are restored by default.

• To restore specified indexes, for example, index1, index2, and Index3, specify the indexes.

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

Default value:

N/A

prefix

No

String

Definition:

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

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:

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

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.

Value range:

1–90

Default value:

N/A

frequency

No

String

Definition:

Frequency of automatically creating snapshots.

Constraints:

N/A

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.

• 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.

Default value:

DAY

delete_auto

No

String

Definition:

Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled.

Constraints:

This parameter is valid only when enable is set to false, indicating that automatic backup is disabled.

Value range:

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

false: Retain automatically created snapshots when an automatic snapshot creation policy is disabled.

Default value:

false

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.