Configuring the Automatic Snapshot Creation Policy

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 you want to create snapshots automatically. 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

indices

No

String

Definition:

Specify the name of the index you want to restore.

Constraints:

You can use "*" to match multiple indexes. For example, index* indicates that all indexes with the prefix index will be restored.

• Or you can restore indexes by specifying their names, for example, index1,index2,index3.

• When "*" is used for index matching, the .opendistro_security index and any system indexes whose name is prefixed with .kibana are filtered out by default. The .opendistro_security index cannot be restored. To restore an index whose name is prefixed with .kibana, you need to specify the index name.

Value range:

The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: "\<|>/?

Default value:

By default, this parameter is left blank.

If you do not specify any index name, all indexes in snapshots will be restored by default.

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 generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: 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.

Constraints:

N/A

Value range:

N/A

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 automated 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

enable

Yes

String

Definition:

Whether to enable the automatic snapshot creation policy.

Constraints:

N/A

Value range:

• true: The automatic snapshot creation policy is enabled.

• false: The automatic snapshot creation policy is disabled.

Default value:

N/A

delete_auto

No

String

Definition:

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

Constraints:

N/A

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

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

200

Request succeeded.

406

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