Function
This API is used to enable automatic snapshot creation for an Elasticsearch or OpenSearch cluster. A snapshot saves a point-in-time copy of a cluster in an OBS bucket. Using this snapshot you can restore the cluster to a previous state.
When automatic snapshot creation is enabled, snapshots are automatically created daily or weekly based on a preset time schedule, ensuring ongoing data protection.
Only Elasticsearch and OpenSearch clusters support automatic snapshot creation.
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 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 The value is a UUID containing 36 characters. Range Cluster ID. Default Value N/A |
Request Parameters
Table 2 Request body parameters | Parameter | Mandatory | Type | Description |
| indices | No | String | Definition: Name of the index to be backed up. Constraints: -
If no index is specified, snapshots will be created for all indexes in the cluster. -
Or you can back up indexes by specifying their names, for example, index1,index2,index3. -
The value can contain a maximum of 1024 characters and cannot contain uppercase letters, spaces, or "<|>/?. You can use an asterisk () to match multiple indexes. For example, index indicates that all indexes with the prefix index will be backed up. Value range: The value can contain 0 to 1,024 characters. It cannot contain uppercase letters, spaces, or the following special characters: "<|>/? Default value: The default value is empty, indicating that all indexes will be backed up. |
| 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 automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy. Constraints If the snapshot creation interval is short or if the data size of indexes is large, the number of automatic snapshots retained may not reach the value set using this parameter. 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. Default value: DAY |
| period | No | String | Definition Time when a snapshot was created. Constraints 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. 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 |
| prefix | Yes | 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 N/A Range The value can contain 1 to 32 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. Default Value snapshot |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Enable the automatic backup function. The system retains seven automatic backup snapshots, performs automatic backup at 16:00 every day, and uses the prefix snapshot for the created snapshot names.
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"
} 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. |