Help Center/ Cloud Search Service/ API Reference/ API V1/ Snapshot Management/ Configuring the Automatic Snapshot Creation Policy
Updated on 2025-11-17 GMT+08:00

Configuring the Automatic Snapshot Creation Policy

Function

This API is used to configure automatic snapshot creation policies. When automatic snapshot creation is enabled, snapshots are automatically created daily or weekly based on a preset time schedule, ensuring ongoing data protection. By configuring an automatic snapshot policy, you reduce manual operations while improving backup reliability and efficiency.

Calling Method

For details, see Calling APIs.

URI

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

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 for which you want to enable automatic snapshot creation. 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 the index to be backed up.

  • You can specify indexes you want to back up. To specify multiple indexes, use commas (,) to separate them, 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:

This parameter is valid only when enable is set to true.

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.

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

Value range:

1–90

Default value:

N/A

enable

Yes

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

delete_auto

No

String

Definition:

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

Constraints:

If automatic snapshot creation is disabled without deleting automatically created snapshots, all such snapshots in the cluster cannot be manually deleted later once automatic snapshot creation is enabled again. Instead, they can only be deleted by the system based on the snapshot lifecycle policy.

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

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

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Configure the automatic snapshot creation policy.

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

{
  "prefix" : "snapshot",
  "period" : "16:00 GMT+08:00",
  "keepday" : 7,
  "frequency" : "DAY",
  "enable" : "true",
  "delete_auto" : "false"
}

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

Java

Configure the automatic snapshot creation policy.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.css.v1.region.CssRegion;
import com.huaweicloud.sdk.css.v1.*;
import com.huaweicloud.sdk.css.v1.model.*;


public class CreateAutoCreatePolicySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CssClient client = CssClient.newBuilder()
                .withCredential(auth)
                .withRegion(CssRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAutoCreatePolicyRequest request = new CreateAutoCreatePolicyRequest();
        request.withClusterId("{cluster_id}");
        SetRDSBackupCnfReq body = new SetRDSBackupCnfReq();
        body.withFrequency("DAY");
        body.withDeleteAuto("false");
        body.withEnable("true");
        body.withKeepday(7);
        body.withPeriod("16:00 GMT+08:00");
        body.withPrefix("snapshot");
        request.withBody(body);
        try {
            CreateAutoCreatePolicyResponse response = client.createAutoCreatePolicy(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Configure the automatic snapshot creation policy.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcss.v1.region.css_region import CssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcss.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAutoCreatePolicyRequest()
        request.cluster_id = "{cluster_id}"
        request.body = SetRDSBackupCnfReq(
            frequency="DAY",
            delete_auto="false",
            enable="true",
            keepday=7,
            period="16:00 GMT+08:00",
            prefix="snapshot"
        )
        response = client.create_auto_create_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Configure the automatic snapshot creation policy.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAutoCreatePolicyRequest{}
	request.ClusterId = "{cluster_id}"
	frequencySetRdsBackupCnfReq:= "DAY"
	deleteAutoSetRdsBackupCnfReq:= "false"
	keepdaySetRdsBackupCnfReq:= int32(7)
	periodSetRdsBackupCnfReq:= "16:00 GMT+08:00"
	prefixSetRdsBackupCnfReq:= "snapshot"
	request.Body = &model.SetRdsBackupCnfReq{
		Frequency: &frequencySetRdsBackupCnfReq,
		DeleteAuto: &deleteAutoSetRdsBackupCnfReq,
		Enable: "true",
		Keepday: &keepdaySetRdsBackupCnfReq,
		Period: &periodSetRdsBackupCnfReq,
		Prefix: &prefixSetRdsBackupCnfReq,
	}
	response, err := client.CreateAutoCreatePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

406

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

Error Codes

See Error Codes.